blob: c7f9794653b6025a9e239cbe8017053acdc85ed1 [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 Lobodzinskidaea5912019-03-07 14:47:09 -0700846bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count,
847 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 Lobodzinskidaea5912019-03-07 14:47:09 -0700887void CoreChecks::RecordQFOTransferBarriers(GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700888 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600889 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
890 for (uint32_t b = 0; b < barrier_count; b++) {
891 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700892 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
893 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600894 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600895 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
896 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600897 barrier_sets.acquire.emplace(barriers[b]);
898 }
899 }
900}
901
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700902bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
903 const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700904 uint32_t imageMemBarrierCount,
905 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600906 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700907 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
908 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600909 return skip;
910}
911
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700912void CoreChecks::RecordBarriersQFOTransfers(GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700913 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
914 const VkImageMemoryBarrier *pImageMemBarriers) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700915 RecordQFOTransferBarriers(cb_state, bufferBarrierCount, pBufferMemBarriers);
916 RecordQFOTransferBarriers(cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600917}
918
919template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700920bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
921 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600922 // Record to the scoreboard or report that we have a duplication
923 bool skip = false;
924 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
925 if (!inserted.second && inserted.first->second != cb_state) {
926 // 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 -0700927 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
928 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
929 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
930 " duplicates existing barrier submitted in this batch from command buffer %s.",
931 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
932 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
933 report_data->FormatHandle(inserted.first->second).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600934 }
935 return skip;
936}
937
938template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700939bool CoreChecks::ValidateQueuedQFOTransferBarriers(GLOBAL_CB_NODE *cb_state, QFOTransferCBScoreboards<Barrier> *scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600940 using BarrierRecord = QFOTransferBarrier<Barrier>;
941 using TypeTag = typename BarrierRecord::Tag;
942 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600943 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700944 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600945 const char *barrier_name = BarrierRecord::BarrierName();
946 const char *handle_name = BarrierRecord::HandleName();
947 // No release should have an extant duplicate (WARNING)
948 for (const auto &release : cb_barriers.release) {
949 // Check the global pending release barriers
950 const auto set_it = global_release_barriers.find(release.handle);
951 if (set_it != global_release_barriers.cend()) {
952 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
953 const auto found = set_for_handle.find(release);
954 if (found != set_for_handle.cend()) {
955 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
956 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700957 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600958 " to dstQueueFamilyIndex %" PRIu32
959 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700960 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600961 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
962 }
963 }
964 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
965 }
966 // Each acquire must have a matching release (ERROR)
967 for (const auto &acquire : cb_barriers.acquire) {
968 const auto set_it = global_release_barriers.find(acquire.handle);
969 bool matching_release_found = false;
970 if (set_it != global_release_barriers.cend()) {
971 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
972 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
973 }
974 if (!matching_release_found) {
975 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
976 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700977 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
978 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
979 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600980 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
981 }
982 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
983 }
984 return skip;
985}
986
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700987bool CoreChecks::ValidateQueuedQFOTransfers(GLOBAL_CB_NODE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700988 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
989 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600990 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700991 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
992 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -0600993 return skip;
994}
995
996template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700997void CoreChecks::RecordQueuedQFOTransferBarriers(GLOBAL_CB_NODE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600998 using BarrierRecord = QFOTransferBarrier<Barrier>;
999 using TypeTag = typename BarrierRecord::Tag;
1000 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001001 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001002
1003 // Add release barriers from this submit to the global map
1004 for (const auto &release : cb_barriers.release) {
1005 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1006 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1007 global_release_barriers[release.handle].insert(release);
1008 }
1009
1010 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1011 for (const auto &acquire : cb_barriers.acquire) {
1012 // NOTE: We're not using [] because we don't want to create entries for missing releases
1013 auto set_it = global_release_barriers.find(acquire.handle);
1014 if (set_it != global_release_barriers.end()) {
1015 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1016 set_for_handle.erase(acquire);
1017 if (set_for_handle.size() == 0) { // Clean up empty sets
1018 global_release_barriers.erase(set_it);
1019 }
1020 }
1021 }
1022}
1023
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001024void CoreChecks::RecordQueuedQFOTransfers(GLOBAL_CB_NODE *cb_state) {
1025 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1026 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001027}
1028
John Zulauf6b4aae82018-05-09 13:03:36 -06001029// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001030void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001031
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001032void CoreChecks::TransitionImageLayouts(GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001033 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001034 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1035 auto mem_barrier = &pImgMemBarriers[i];
1036 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001037
Chris Forbes4de4b132017-08-21 11:27:08 -07001038 // For ownership transfers, the barrier is specified twice; as a release
1039 // operation on the yielding queue family, and as an acquire operation
1040 // on the acquiring queue family. This barrier may also include a layout
1041 // transition, which occurs 'between' the two operations. For validation
1042 // purposes it doesn't seem important which side performs the layout
1043 // transition, but it must not be performed twice. We'll arbitrarily
1044 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001045 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001046 continue;
1047 }
1048
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001049 VkImageCreateInfo *image_create_info = &(GetImageState(mem_barrier->image)->createInfo);
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001050 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1051 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1052
Dave Houltonb3f4b282018-02-22 16:25:16 -07001053 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1054 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1055 // for all (potential) layer sub_resources.
1056 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1057 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1058 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1059 }
1060
Tony-LunarG0d27b302018-10-08 09:26:21 -06001061 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1062 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001063 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001064 if (FormatIsMultiplane(image_create_info->format)) {
1065 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1066 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1067 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1068 if (FormatPlaneCount(image_create_info->format) > 2) {
1069 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1070 }
1071 }
1072 }
1073 }
1074
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001075 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001076 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001077 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001078 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001079 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_COLOR_BIT);
1080 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_DEPTH_BIT);
1081 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_STENCIL_BIT);
1082 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001083 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001084 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1085 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1086 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001087 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001088 }
1089 }
1090 }
1091}
1092
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001093bool CoreChecks::VerifyImageLayout(GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state, VkImageSubresourceLayers subLayers,
1094 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1095 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001096 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001097 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001098
1099 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1100 uint32_t layer = i + subLayers.baseArrayLayer;
1101 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1102 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001103 if (FindCmdBufLayout(cb_node, image, sub, node)) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001104 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001105 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001106 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1107 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001108 "%s: Cannot use image %s (layer=%u mip=%u) with specific layout %s that doesn't match the actual "
1109 "current layout %s.",
1110 caller, report_data->FormatHandle(image).c_str(), layer, subLayers.mipLevel,
1111 string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001112 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001113 }
1114 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001115 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1116 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1117 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001118 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1119 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001120 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001121 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001122 kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07001123 "%s: For optimal performance image %s layout should be %s instead of GENERAL.", caller,
1124 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001125 }
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001126 } else if (GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001127 if (image_state->shared_presentable) {
1128 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001129 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1130 layout_invalid_msg_code,
1131 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1132 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001133 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001134 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001135 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001136 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001137 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 -07001138 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001139 "%s: Layout for image %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1140 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1141 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001142 }
1143 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001144 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001145}
1146
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001147void CoreChecks::TransitionFinalSubpassLayouts(GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001148 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001149 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001150 if (!renderPass) return;
1151
Tobias Hectorbbb12282018-10-22 15:17:59 +01001152 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001153 if (framebuffer_state) {
1154 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001155 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001156 if (view_state) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001157 SetImageViewLayout(pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001158 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001159 }
1160 }
1161}
Dave Houltone19e20d2018-02-02 16:32:41 -07001162
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001163#ifdef VK_USE_PLATFORM_ANDROID_KHR
1164// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1165// This could also move into a seperate core_validation_android.cpp file... ?
1166
1167//
1168// AHB-specific validation within non-AHB APIs
1169//
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001170bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001171 bool skip = false;
1172
1173 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1174 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001175 if (0 != ext_fmt_android->externalFormat) {
1176 if (VK_FORMAT_UNDEFINED != create_info->format) {
1177 skip |=
1178 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1179 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001180 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001181 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1182 }
1183
1184 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1185 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1186 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001187 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001188 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1189 }
1190
1191 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1192 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1193 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001194 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001195 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1196 }
1197
1198 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1199 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1200 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001201 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001202 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1203 }
1204 }
1205
Mark Lobodzinskieb8654d2019-03-07 11:14:47 -07001206 auto ahb_formats = GetAHBExternalFormatsSet();
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001207 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1208 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1209 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001210 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001211 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1212 }
1213 }
1214
Dave Houltond9611312018-11-19 17:03:36 -07001215 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001216 if (VK_FORMAT_UNDEFINED == create_info->format) {
1217 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1218 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001219 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001220 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1221 }
1222 }
1223
1224 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1225 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1226 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001227 skip |=
1228 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1229 "VUID-VkImageCreateInfo-pNext-02393",
1230 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1231 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1232 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001233 }
1234
1235 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1236 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1237 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001238 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001239 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1240 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1241 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1242 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001243 }
1244
1245 return skip;
1246}
1247
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001248void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001249 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1250 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1251 is_node->imported_ahb = true;
1252 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001253 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001254 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001255 is_node->has_ahb_format = true;
1256 is_node->ahb_format = ext_fmt_android->externalFormat;
1257 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001258}
1259
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001260bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001261 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001262 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001263
1264 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001265 if (VK_FORMAT_UNDEFINED != create_info->format) {
1266 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1267 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1268 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1269 "format member is %s.",
1270 string_VkFormat(create_info->format));
1271 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001272
Dave Houltond9611312018-11-19 17:03:36 -07001273 // Chain must include a compatible ycbcr conversion
1274 bool conv_found = false;
1275 uint64_t external_format = 0;
1276 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1277 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001278 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskieb8654d2019-03-07 11:14:47 -07001279 auto fmap = GetYcbcrConversionFormatMap();
Dave Houltond9611312018-11-19 17:03:36 -07001280 if (fmap->find(conv_handle) != fmap->end()) {
1281 conv_found = true;
1282 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001283 }
Dave Houltond9611312018-11-19 17:03:36 -07001284 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001285 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001286 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 -07001287 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1288 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1289 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1290 }
1291
1292 // Errors in create_info swizzles
1293 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1294 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1295 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1296 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1297 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1298 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1299 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1300 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001301 }
1302 }
Dave Houltond9611312018-11-19 17:03:36 -07001303
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304 return skip;
1305}
1306
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001307bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001308 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001309
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001310 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001311 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1312 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1313 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001314 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001315 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1316 "bound to memory.");
1317 }
1318 return skip;
1319}
1320
1321#else
1322
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001323bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001324 return false;
1325}
1326
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001327void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001328
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001329bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001330
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001331bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001332
1333#endif // VK_USE_PLATFORM_ANDROID_KHR
1334
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001335bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1336 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001337 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001338
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001339 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001340 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001341 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1342 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1343 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1344 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001345 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001346 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001347 }
1348
Dave Houlton130c0212018-01-29 13:39:56 -07001349 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001350 skip |= log_msg(
1351 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1352 "VUID-VkImageCreateInfo-flags-00949",
1353 "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 -07001354 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001355
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001356 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001357 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1358 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1359 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001360 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 +00001361 "VUID-VkImageCreateInfo-usage-00964",
1362 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1363 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001364 }
1365
1366 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
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-00965",
1369 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1370 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001371 }
1372
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001373 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001374 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001375 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1376 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1377 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1378 string_VkFormat(pCreateInfo->format));
1379 } else {
1380 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1381 const char *format_string = string_VkFormat(pCreateInfo->format);
1382 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1383 "VUID-VkImageCreateInfo-mipLevels-02255",
1384 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1385 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1386 }
Dave Houlton130c0212018-01-29 13:39:56 -07001387
Dave Houltona585d132019-01-18 13:05:42 -07001388 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1389 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1390 (uint64_t)pCreateInfo->samples;
1391 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001392
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001393 // Round up to imageGranularity boundary
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001394 VkDeviceSize imageGranularity = GetPDProperties()->limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001395 uint64_t ig_mask = imageGranularity - 1;
1396 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001397
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001398 if (total_size > format_limits.maxResourceSize) {
1399 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1400 kVUID_Core_Image_InvalidFormatLimitsViolation,
1401 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1402 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1403 total_size, format_limits.maxResourceSize);
1404 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001405
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001406 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1407 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1408 "VUID-VkImageCreateInfo-arrayLayers-02256",
1409 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1410 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1411 }
1412
1413 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1414 skip |=
1415 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1416 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001417 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001418 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001419 }
1420
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001421 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001422 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 -06001423 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001424 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1425 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001426 }
1427
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001428 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001429 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1430 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1431 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1432 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001433 skip |=
1434 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1435 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1436 "format must be block, ETC or ASTC compressed, but is %s",
1437 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001438 }
1439 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1440 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001441 skip |=
1442 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1443 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1444 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001445 }
1446 }
1447 }
1448
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001449 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001450 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1451 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1452 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001453 }
1454
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001455 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001456}
1457
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001458void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1459 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001460 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001461 IMAGE_LAYOUT_NODE image_state;
1462 image_state.layout = pCreateInfo->initialLayout;
1463 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001464 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001465 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001466 RecordCreateImageANDROID(pCreateInfo, is_node);
1467 }
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001468 GetImageMap()->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001469 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001470 (*GetImageSubresourceMap())[*pImage].push_back(subpair);
1471 (*GetImageLayoutMap())[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001472}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001473
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001474bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001475 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001476 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001477 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001478 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001479 if (image_state) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001480 skip |= ValidateObjectNotInUse(device_data, image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001481 }
1482 return skip;
1483}
1484
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001485void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001486 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001487 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001488 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001489 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001490 InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001491 // Clean up memory mapping, bindings and range references for image
1492 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001493 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001494 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001495 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001496 }
1497 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001498 ClearMemoryObjectBindings(obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001499 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001500 // Remove image from imageMap
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001501 GetImageMap()->erase(image);
1502 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap = GetImageSubresourceMap();
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001503
1504 const auto &sub_entry = imageSubresourceMap->find(image);
1505 if (sub_entry != imageSubresourceMap->end()) {
1506 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001507 GetImageLayoutMap()->erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001508 }
1509 imageSubresourceMap->erase(sub_entry);
1510 }
1511}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001512
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001513bool CoreChecks::ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001514 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001515
1516 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1517 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1518 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001519 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001520 }
1521
Dave Houlton1d2022c2017-03-29 11:43:58 -06001522 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001523 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1524 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001525 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001526 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001527 char const str[] = "vkCmdClearColorImage called with compressed image.";
1528 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001529 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001530 }
1531
1532 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1533 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1534 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001535 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001536 }
1537 return skip;
1538}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001539
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001540uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1541 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1542 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001543 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001544 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001545 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001546 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001547}
1548
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001549uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1550 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1551 uint32_t array_layer_count = range->layerCount;
1552 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1553 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001554 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001555 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001556}
1557
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001558bool CoreChecks::VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
1559 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001560 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001561
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001562 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1563 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001564
1565 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1566 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001567 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1568 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001569 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 -06001570 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001571 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1572 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001573 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001574 if (!GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001575 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001576 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 -06001577 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001578 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1579 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001580
1581 } else {
1582 if (image_state->shared_presentable) {
1583 skip |= log_msg(
1584 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,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001586 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1587 string_VkImageLayout(dest_image_layout));
1588 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001589 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001590 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001591 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001592 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001593 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001594 } else {
1595 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1596 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001597 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 -06001598 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001599 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1600 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001601 }
1602 }
1603
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001604 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1605 uint32_t level = level_index + range.baseMipLevel;
1606 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1607 uint32_t layer = layer_index + range.baseArrayLayer;
1608 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001609 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001610 if (FindCmdBufLayout(cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001611 if (node.layout != dest_image_layout) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001612 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001613 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001614 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001615 } else {
1616 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1617 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001618 skip |=
1619 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1620 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1621 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001622 }
1623 }
1624 }
1625 }
1626
1627 return skip;
1628}
1629
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001630void CoreChecks::RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image,
1631 VkImageSubresourceRange range, VkImageLayout dest_image_layout) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001632 VkImageCreateInfo *image_create_info = &(GetImageState(image)->createInfo);
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001633 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1634 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001635
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001636 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1637 uint32_t level = level_index + range.baseMipLevel;
1638 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1639 uint32_t layer = layer_index + range.baseArrayLayer;
1640 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001641 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001642 if (!FindCmdBufLayout(cb_node, image, sub, node)) {
1643 SetLayout(cb_node, image, sub, IMAGE_CMD_BUF_LAYOUT_NODE(dest_image_layout, dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001644 }
1645 }
1646 }
1647}
1648
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001649bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1650 const VkClearColorValue *pColor, uint32_t rangeCount,
1651 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001652 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1653
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001654 bool skip = false;
1655 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001656 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001657 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001658 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001659 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001660 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001661 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001662 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001663 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001664 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
1665 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993",
1666 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001667 }
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001668 skip |= InsideRenderPass(device_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001669 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001670 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001671 skip |= ValidateCmdClearColorSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
1672 skip |= ValidateImageAttributes(device_data, image_state, pRanges[i]);
1673 skip |= VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001674 }
1675 }
1676 return skip;
1677}
1678
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001679void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1680 const VkClearColorValue *pColor, uint32_t rangeCount,
1681 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001682 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1683
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001684 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001685 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001686 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001687 AddCommandBufferBindingImage(device_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001688 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001689 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001690 }
1691 }
1692}
1693
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001694bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1695 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1696 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001697 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001698 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001699
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001700 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001701 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001702 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001703 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001704 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001705 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001706 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001707 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001708 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001709 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04001710 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001711 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1712 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001713 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001714 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001715 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001716 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001717 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001718 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001719 skip |=
1720 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001721 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001722 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1723 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001724 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001725 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1726 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001727 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 -06001728 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001729 }
1730 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001731 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001732 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001733 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 -06001734 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001735 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001736 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1737 char const str[] =
1738 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1739 "set.";
1740 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 -06001741 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001742 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001743 }
1744 return skip;
1745}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001746
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001747void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1748 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1749 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001750 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1751
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001752 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001753 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001754 if (cb_node && image_state) {
1755 AddCommandBufferBindingImage(device_data, cb_node, image_state);
1756 for (uint32_t i = 0; i < rangeCount; ++i) {
1757 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
1758 }
1759 }
1760}
1761
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001762// Returns true if [x, xoffset] and [y, yoffset] overlap
1763static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1764 bool result = false;
1765 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1766 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1767
1768 if (intersection_max > intersection_min) {
1769 result = true;
1770 }
1771 return result;
1772}
1773
Dave Houltonc991cc92018-03-06 11:08:51 -07001774// Returns true if source area of first copy region intersects dest area of second region
1775// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1776static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001777 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001778
Dave Houltonc991cc92018-03-06 11:08:51 -07001779 // Separate planes within a multiplane image cannot intersect
1780 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001781 return result;
1782 }
1783
Dave Houltonc991cc92018-03-06 11:08:51 -07001784 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1785 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1786 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001787 result = true;
1788 switch (type) {
1789 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001790 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001791 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001792 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001793 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001794 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001795 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001796 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001797 break;
1798 default:
1799 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1800 assert(false);
1801 }
1802 }
1803 return result;
1804}
1805
Dave Houltonfc1a4052017-04-27 14:32:45 -06001806// Returns non-zero if offset and extent exceed image extents
1807static const uint32_t x_bit = 1;
1808static const uint32_t y_bit = 2;
1809static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001810static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001811 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001812 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001813 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1814 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001815 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001816 }
1817 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1818 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001819 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001820 }
1821 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1822 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001823 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001824 }
1825 return result;
1826}
1827
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001828// Test if two VkExtent3D structs are equivalent
1829static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1830 bool result = true;
1831 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1832 (extent->depth != other_extent->depth)) {
1833 result = false;
1834 }
1835 return result;
1836}
1837
Dave Houltonee281a52017-12-08 13:51:02 -07001838// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1839// Destination image texel extents must be adjusted by block size for the dest validation checks
1840VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1841 VkExtent3D adjusted_extent = extent;
1842 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001843 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001844 adjusted_extent.width /= block_size.width;
1845 adjusted_extent.height /= block_size.height;
1846 adjusted_extent.depth /= block_size.depth;
1847 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001848 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001849 adjusted_extent.width *= block_size.width;
1850 adjusted_extent.height *= block_size.height;
1851 adjusted_extent.depth *= block_size.depth;
1852 }
1853 return adjusted_extent;
1854}
1855
Dave Houlton6f9059e2017-05-02 17:15:13 -06001856// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001857static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1858 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001859
1860 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001861 if (mip >= img->createInfo.mipLevels) {
1862 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001863 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001864
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001865 // 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 -06001866 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001867
Dave Houltone48cd112019-01-03 17:01:18 -07001868 // If multi-plane, adjust per-plane extent
1869 if (FormatIsMultiplane(img->createInfo.format)) {
1870 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1871 extent.width /= divisors.width;
1872 extent.height /= divisors.height;
1873 }
1874
Jeff Bolzef40fec2018-09-01 22:04:34 -05001875 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1876 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001877 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001878 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1879 } else {
1880 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1881 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1882 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1883 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001884
Dave Houlton6f9059e2017-05-02 17:15:13 -06001885 // Image arrays have an effective z extent that isn't diminished by mip level
1886 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001887 extent.depth = img->createInfo.arrayLayers;
1888 }
1889
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001890 return extent;
1891}
1892
1893// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001894static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001895 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1896}
1897
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001898// Test if the extent argument has any dimensions set to 0.
1899static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1900 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1901}
1902
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001903// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001904VkExtent3D CoreChecks::GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001905 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1906 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07001907 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001908 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001909 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001910 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001911 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001912 granularity.width *= block_size.width;
1913 granularity.height *= block_size.height;
1914 }
1915 }
1916 return granularity;
1917}
1918
1919// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1920static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1921 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001922 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1923 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001924 valid = false;
1925 }
1926 return valid;
1927}
1928
1929// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001930bool CoreChecks::CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1931 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
1932 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001933 bool skip = false;
1934 VkExtent3D offset_extent = {};
1935 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1936 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1937 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001938 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001939 // 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 -07001940 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001941 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 -04001942 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001943 "%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 "
1944 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001945 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001946 }
1947 } else {
1948 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1949 // integer multiples of the image transfer granularity.
1950 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001951 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 -04001952 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001953 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1954 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001955 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1956 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001957 }
1958 }
1959 return skip;
1960}
1961
1962// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001963bool CoreChecks::CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1964 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1965 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
1966 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001967 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001968 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001969 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1970 // subresource extent.
1971 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001972 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 -04001973 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001974 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1975 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1976 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1977 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001978 }
1979 } else {
1980 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1981 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1982 // subresource extent dimensions.
1983 VkExtent3D offset_extent_sum = {};
1984 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1985 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1986 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001987 bool x_ok = true;
1988 bool y_ok = true;
1989 bool z_ok = true;
1990 switch (image_type) {
1991 case VK_IMAGE_TYPE_3D:
1992 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1993 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001994 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001995 case VK_IMAGE_TYPE_2D:
1996 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1997 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001998 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001999 case VK_IMAGE_TYPE_1D:
2000 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2001 (subresource_extent->width == offset_extent_sum.width));
2002 break;
2003 default:
2004 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2005 assert(false);
2006 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002007 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002008 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002009 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002010 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2011 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2012 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2013 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2014 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2015 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002016 }
2017 }
2018 return skip;
2019}
2020
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002021bool CoreChecks::ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2022 uint32_t mip_level, const uint32_t i, const char *function, const char *member,
2023 const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002024 bool skip = false;
2025 if (mip_level >= img->createInfo.mipLevels) {
2026 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2027 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07002028 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
2029 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002030 }
2031 return skip;
2032}
2033
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002034bool CoreChecks::ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2035 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i,
2036 const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002037 bool skip = false;
2038 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2039 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2040 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2041 HandleToUint64(cb_node->commandBuffer), vuid,
2042 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07002043 "%u, but provided image %s has %u array layers.",
2044 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2045 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002046 }
2047 return skip;
2048}
2049
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002050// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002051bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2052 const IMAGE_STATE *img, const VkBufferImageCopy *region,
2053 const uint32_t i, const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002054 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002055 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2056 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2057 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2058 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2059 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002060 return skip;
2061}
2062
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002063// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002064bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2065 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2066 const VkImageCopy *region, const uint32_t i,
2067 const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002068 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002069 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002070 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002071 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2072 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002073 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002074 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002075 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002076 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002077
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002078 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002079 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002080 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2081 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002082 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002083 const VkExtent3D dest_effective_extent =
2084 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002085 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002086 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002087 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002088 return skip;
2089}
2090
Dave Houlton6f9059e2017-05-02 17:15:13 -06002091// Validate contents of a VkImageCopy struct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002092bool CoreChecks::ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data,
2093 const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
2094 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002095 bool skip = false;
2096
2097 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002098 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002099
2100 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002101 const VkExtent3D src_copy_extent = region.extent;
2102 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002103 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2104
Dave Houlton6f9059e2017-05-02 17:15:13 -06002105 bool slice_override = false;
2106 uint32_t depth_slices = 0;
2107
2108 // Special case for copying between a 1D/2D array and a 3D image
2109 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2110 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002111 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002112 slice_override = (depth_slices != 1);
2113 } 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 -07002114 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002115 slice_override = (depth_slices != 1);
2116 }
2117
2118 // Do all checks on source image
2119 //
2120 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002121 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2122 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 -06002123 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002124 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002125 "be 0 and 1, respectively.",
2126 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002127 }
2128 }
2129
Dave Houlton533be9f2018-03-26 17:08:30 -06002130 // VUID-VkImageCopy-srcImage-01785
2131 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2132 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 -06002133 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002134 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002135 "these must be 0 and 1, respectively.",
2136 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002137 }
2138
Dave Houlton533be9f2018-03-26 17:08:30 -06002139 // VUID-VkImageCopy-srcImage-01787
2140 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
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-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002143 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2144 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002145 }
2146
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002147 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002148 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002149 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002150 skip |=
2151 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002152 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002153 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002154 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2155 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002156 }
2157 }
2158 } else { // Pre maint 1
2159 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002160 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002161 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 -06002162 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002163 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2164 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002165 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2166 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002167 }
2168 }
2169 }
2170
Dave Houltonc991cc92018-03-06 11:08:51 -07002171 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002172 bool ext_ycbcr = GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002173 if (FormatIsCompressed(src_state->createInfo.format) ||
2174 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002175 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002176 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002177 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2178 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2179 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002180 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002181 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 -07002182 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002183 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002184 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002185 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002186 }
2187
Dave Houlton94a00372017-12-14 15:08:47 -07002188 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002189 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2190 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002191 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002192 skip |=
2193 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002194 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002195 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002196 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002197 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002198 }
2199
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002200 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002201 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2202 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002203 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002204 skip |=
2205 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002206 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002207 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002208 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002209 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002210 }
2211
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002212 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002213 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2214 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002215 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216 skip |=
2217 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002218 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002219 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002220 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002221 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002222 }
2223 } // Compressed
2224
2225 // Do all checks on dest image
2226 //
2227 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002228 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002229 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 -06002230 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002231 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002232 "these must be 0 and 1, respectively.",
2233 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002234 }
2235 }
2236
Dave Houlton533be9f2018-03-26 17:08:30 -06002237 // VUID-VkImageCopy-dstImage-01786
2238 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2239 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 -06002240 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002241 "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 -06002242 "and 1, respectively.",
2243 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002244 }
2245
2246 // VUID-VkImageCopy-dstImage-01788
2247 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
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-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002250 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2251 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002252 }
2253
2254 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002255 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002256 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 -06002257 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002258 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002259 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2260 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002261 }
2262 }
2263 // VU01199 changed with mnt1
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002264 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002265 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002266 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 skip |=
2268 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002269 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002271 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2272 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002273 }
2274 }
2275 } else { // Pre maint 1
2276 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002277 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002278 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 -06002279 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002280 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2281 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002282 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2283 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002284 }
2285 }
2286 }
2287
Dave Houltonc991cc92018-03-06 11:08:51 -07002288 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2289 if (FormatIsCompressed(dst_state->createInfo.format) ||
2290 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002291 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002292
2293 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002294 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2295 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2296 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002297 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002298 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 -07002299 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002300 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002301 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002302 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303 }
2304
Dave Houlton94a00372017-12-14 15:08:47 -07002305 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002306 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2307 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002308 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002309 skip |=
2310 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002311 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002312 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002313 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002314 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002315 }
2316
Dave Houltonee281a52017-12-08 13:51:02 -07002317 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2318 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2319 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002320 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002321 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 -07002322 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002323 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2324 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002325 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002326 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002327 }
2328
Dave Houltonee281a52017-12-08 13:51:02 -07002329 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2330 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2331 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002332 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002333 skip |=
2334 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002335 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002336 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002337 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002338 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002339 }
2340 } // Compressed
2341 }
2342 return skip;
2343}
2344
Dave Houltonc991cc92018-03-06 11:08:51 -07002345// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002346bool CoreChecks::CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer,
2347 const IMAGE_STATE *src_image_state, const IMAGE_STATE *dst_image_state,
2348 const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002349 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002350
2351 // Neither image is multiplane
2352 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2353 // If neither image is multi-plane the aspectMask member of src and dst must match
2354 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2355 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002356 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002357 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2358 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 -06002359 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002360 }
2361 } else {
2362 // Source image multiplane checks
2363 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2364 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2365 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2366 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002367 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002368 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 -06002369 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002370 }
2371 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2372 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2373 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002374 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002375 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002376 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002377 }
2378 // Single-plane to multi-plane
2379 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2380 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2381 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002382 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002383 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 -06002384 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002385 }
2386
2387 // Dest image multiplane checks
2388 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2389 aspect = region.dstSubresource.aspectMask;
2390 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2391 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002392 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002393 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 -06002394 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002395 }
2396 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2397 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2398 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002399 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002400 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 -06002401 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002402 }
2403 // Multi-plane to single-plane
2404 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2405 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2406 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002407 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002408 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 -06002409 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002410 }
2411 }
2412
2413 return skip;
2414}
2415
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002416bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2417 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2418 const VkImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002419 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002420 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002421 auto src_image_state = GetImageState(srcImage);
2422 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002423 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002424
2425 skip = ValidateImageCopyData(device_data, report_data, regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002426
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002427 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2428
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002429 for (uint32_t i = 0; i < regionCount; i++) {
2430 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002431
2432 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2433 VkExtent3D src_copy_extent = region.extent;
2434 VkExtent3D dst_copy_extent =
2435 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2436
Dave Houlton6f9059e2017-05-02 17:15:13 -06002437 bool slice_override = false;
2438 uint32_t depth_slices = 0;
2439
2440 // Special case for copying between a 1D/2D array and a 3D image
2441 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2442 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2443 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002444 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002445 slice_override = (depth_slices != 1);
2446 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2447 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002448 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002449 slice_override = (depth_slices != 1);
2450 }
2451
Cort Strattond619a302018-05-17 19:46:32 -07002452 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2453 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002454 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2455 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2456 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2457 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2458 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2459 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2460 "VUID-vkCmdCopyImage-srcSubresource-01698");
2461 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2462 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2463 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002464
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002465 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002466 // No chance of mismatch if we're overriding depth slice count
2467 if (!slice_override) {
2468 // The number of depth slices in srcSubresource and dstSubresource must match
2469 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2470 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002471 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2472 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002473 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002474 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2475 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002476 if (src_slices != dst_slices) {
2477 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002478 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002479 << "] do not match";
2480 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002481 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002482 }
2483 }
2484 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002485 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002486 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002487 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002488 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002489 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002490 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 -06002491 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002492 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002493 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002494
Dave Houltonc991cc92018-03-06 11:08:51 -07002495 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002496 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002497 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2498 }
2499
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002500 if (!GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002501 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2502 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002503 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002504 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 -06002505 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002506 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002507 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002508
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002509 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002510 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002511 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002512 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002513 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2514 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 -06002515 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002516 }
2517
2518 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002519 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_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
2522 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002523 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-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002525 }
2526
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002527 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2528 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2529 // 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 -07002530 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2531 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002532 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002533 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002534 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2535 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2536 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002537 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 -06002538 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002539 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002540
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002541 // 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 -07002542 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2543 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002544 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002545 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002546 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2547 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2548 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002549 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 -06002550 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002551 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002552 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002553
Dave Houltonfc1a4052017-04-27 14:32:45 -06002554 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002555 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2556 if (slice_override) src_copy_extent.depth = depth_slices;
2557 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002558 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002559 skip |=
2560 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2561 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2562 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2563 "width [%1d].",
2564 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002565 }
2566
2567 if (extent_check & y_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-00145",
2571 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2572 "height [%1d].",
2573 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002574 }
2575 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002576 skip |=
2577 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2578 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2579 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2580 "depth [%1d].",
2581 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002582 }
2583
Dave Houltonee281a52017-12-08 13:51:02 -07002584 // Adjust dest extent if necessary
2585 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2586 if (slice_override) dst_copy_extent.depth = depth_slices;
2587
2588 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002589 if (extent_check & x_bit) {
2590 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 -06002591 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002592 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002593 "width [%1d].",
2594 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002595 }
2596 if (extent_check & y_bit) {
2597 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 -06002598 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002599 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002600 "height [%1d].",
2601 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002602 }
2603 if (extent_check & z_bit) {
2604 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002605 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002606 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002607 "depth [%1d].",
2608 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002609 }
2610
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002611 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2612 // must not overlap in memory
2613 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002614 for (uint32_t j = 0; j < regionCount; j++) {
2615 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002616 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002617 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002618 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002619 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 -06002620 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002621 }
2622 }
2623 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002624 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002625
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2627 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2628 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002629 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002630 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2631 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002632 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 -06002633 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002634 }
2635 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002636 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002637 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2638 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 -06002639 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002640 }
2641 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002642
Dave Houlton33c22b72017-02-28 13:16:02 -07002643 // Source and dest image sample counts must match
2644 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2645 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2646 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 -06002647 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002648 }
2649
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002650 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2651 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002652 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002653 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2654 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2655 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2656 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07002657 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002658 skip |=
2659 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002660 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002661 skip |=
2662 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002663 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002664 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002665 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002666 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002667 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002668 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002669 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002670 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002671 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002672 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2673 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002674 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002675 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002676 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2677 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002678 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002679 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002680 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2681 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002682 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002683 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2684 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002685 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002686 &pRegions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002687 }
2688
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002689 return skip;
2690}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002691
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002692void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2693 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2694 const VkImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002695 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002696 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002697 auto src_image_state = GetImageState(srcImage);
2698 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002699
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002700 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002701 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002702 SetImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2703 SetImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002704 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002705 // Update bindings between images and cmd buffer
2706 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2707 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002708}
2709
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002710// Returns true if sub_rect is entirely contained within rect
2711static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2712 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2713 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2714 return false;
2715 return true;
2716}
2717
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002718bool CoreChecks::ValidateClearAttachmentExtent(layer_data *device_data, VkCommandBuffer command_buffer, uint32_t attachment_index,
2719 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2720 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002721 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002722 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2723 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002724 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002725 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002726
2727 for (uint32_t j = 0; j < rect_count; j++) {
2728 if (!ContainsRect(render_area, clear_rects[j].rect)) {
2729 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2730 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2731 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2732 "the current render pass instance.",
2733 j);
2734 }
2735
2736 if (image_view_state) {
2737 // The layers specified by a given element of pRects must be contained within every attachment that
2738 // pAttachments refers to
2739 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2740 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2741 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
2742 skip |=
2743 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2744 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2745 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2746 "of pAttachment[%d].",
2747 j, attachment_index);
2748 }
2749 }
2750 }
2751 return skip;
2752}
2753
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002754bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2755 const VkClearAttachment *pAttachments, uint32_t rectCount,
2756 const VkClearRect *pRects) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002757 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2758
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002759 GLOBAL_CB_NODE *cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002760
2761 bool skip = false;
2762 if (cb_node) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002763 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002764 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002765 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002766 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002767 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002768 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2769 // 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 -07002770 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2771 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002772 skip |=
2773 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2774 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2775 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2776 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2777 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002778 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002779 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002780 }
2781
2782 // Validate that attachment is in reference list of active subpass
2783 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002784 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002785 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002786 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002787 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002788 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2789 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002790
John Zulauf3a548ef2019-02-01 16:14:07 -07002791 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2792 auto clear_desc = &pAttachments[attachment_index];
2793 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002794
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002795 if (0 == clear_desc->aspectMask) {
2796 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 -06002797 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002798 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2799 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 -06002800 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002801 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002802 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2803 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2804 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2805 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002806 skip |= log_msg(
2807 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2808 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2809 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2810 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2811 attachment_index, clear_desc->colorAttachment,
2812 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2813 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2814
John Zulauff2582972019-02-09 14:53:30 -07002815 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2816 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002817 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002818 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2819 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2820 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2821 " subpass %u. colorAttachmentCount=%u",
2822 attachment_index, clear_desc->colorAttachment,
2823 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2824 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002825 }
John Zulauff2582972019-02-09 14:53:30 -07002826 fb_attachment = color_attachment;
2827
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002828 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2829 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2830 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002831 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002832 skip |=
2833 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2834 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002835 }
2836 } else { // Must be depth and/or stencil
2837 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2838 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002839 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002840 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 -07002841 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2842 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002843 }
2844 if (!subpass_desc->pDepthStencilAttachment ||
2845 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2846 skip |= log_msg(
2847 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002848 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002849 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002850 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002851 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002852 }
2853 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002854 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002855 skip |= ValidateClearAttachmentExtent(device_data, commandBuffer, attachment_index, framebuffer, fb_attachment,
2856 render_area, rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002857 } else {
2858 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2859 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2860 if (!clear_rect_copy) {
2861 // We need a copy of the clear rectangles that will persist until the last lambda executes
2862 // but we want to create it as lazily as possible
2863 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002864 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002865
2866 auto val_fn = [device_data, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
2867 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2868 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002869 FRAMEBUFFER_STATE *framebuffer = device_data->GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002870 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2871 bool skip = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002872 skip =
2873 device_data->ValidateClearAttachmentExtent(device_data, commandBuffer, attachment_index, framebuffer,
2874 fb_attachment, render_area, rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002875 return skip;
2876 };
2877 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002878 }
2879 }
2880 }
2881 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002882}
2883
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002884bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2885 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2886 const VkImageResolve *pRegions) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002887 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002888 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002889 auto src_image_state = GetImageState(srcImage);
2890 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002891
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002892 bool skip = false;
2893 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002894 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2895 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002896 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002897 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002898 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002899 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002900 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002901 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2902 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002903
Cort Stratton7df30962018-05-17 19:45:57 -07002904 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002905 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002906 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002907 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2908 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2909 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002910 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002911 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2912 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002913 // For each region, the number of layers in the image subresource should not be zero
2914 // For each region, src and dest image aspect must be color only
2915 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002916 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2917 "srcSubresource", i);
2918 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2919 "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002920 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002921 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2922 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002923 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002924 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2925 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002926 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2927 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2928 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2929 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2930 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2931 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2932 "VUID-vkCmdResolveImage-srcSubresource-01711");
2933 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2934 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2935 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002936
2937 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002938 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2939 skip |= log_msg(
2940 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002941 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002942 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002943 }
Cort Stratton7df30962018-05-17 19:45:57 -07002944 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002945 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2946 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2947 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002948 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002949 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 -06002950 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002951 }
2952 }
2953
2954 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2955 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002956 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 -06002957 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002958 }
2959 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2960 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002961 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 -06002962 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002963 }
2964 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2965 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2966 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 -06002967 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002968 }
2969 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2970 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2971 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 -06002972 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002973 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002974 } else {
2975 assert(0);
2976 }
2977 return skip;
2978}
2979
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002980void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2981 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2982 const VkImageResolve *pRegions) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002983 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002984 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002985 auto src_image_state = GetImageState(srcImage);
2986 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002987
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002988 // Update bindings between images and cmd buffer
2989 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2990 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002991}
2992
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002993bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2994 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2995 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002996 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002997 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002998 auto src_image_state = GetImageState(srcImage);
2999 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003000
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003001 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003002 if (cb_node) {
3003 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3004 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003005 if (cb_node && src_image_state && dst_image_state) {
3006 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003007 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003008 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003009 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003010 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3011 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003012 skip |=
3013 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
3014 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3015 skip |=
3016 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
3017 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003018 skip |=
3019 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003020 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003021 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04003022 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003023 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04003024 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003025 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003026
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003027 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003028
Dave Houlton33c2d252017-06-09 17:08:32 -06003029 VkFormat src_format = src_image_state->createInfo.format;
3030 VkFormat dst_format = dst_image_state->createInfo.format;
3031 VkImageType src_type = src_image_state->createInfo.imageType;
3032 VkImageType dst_type = dst_image_state->createInfo.imageType;
3033
Cort Stratton186b1a22018-05-01 20:18:06 -04003034 if (VK_FILTER_LINEAR == filter) {
3035 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003036 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3037 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003038 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003039 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
3040 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003041 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003042 }
3043
3044 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3045 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 -06003046 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003047 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003048 }
3049
Dave Houlton33c2d252017-06-09 17:08:32 -06003050 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3051 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3052 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 -06003053 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003054 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003055 }
3056
3057 // Validate consistency for unsigned formats
3058 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3059 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003060 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003061 << "the other one must also have unsigned integer format. "
3062 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3063 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 -06003064 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003065 }
3066
3067 // Validate consistency for signed formats
3068 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3069 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003070 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003071 << "the other one must also have signed integer format. "
3072 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3073 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 -06003074 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003075 }
3076
3077 // Validate filter for Depth/Stencil formats
3078 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3079 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003080 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003081 << "then filter must be VK_FILTER_NEAREST.";
3082 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 -06003083 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003084 }
3085
3086 // Validate aspect bits and formats for depth/stencil images
3087 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3088 if (src_format != dst_format) {
3089 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003090 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003091 << "stencil, the other one must have exactly the same format. "
3092 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3093 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003094 skip |=
3095 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3096 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003097 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003098 } // Depth or Stencil
3099
3100 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003101 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003102 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003103 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3104 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3105 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003106 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003107 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3108 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003109 for (uint32_t i = 0; i < regionCount; i++) {
3110 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003111 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003112 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003113 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3114 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003115 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003116 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3117 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003118 skip |=
3119 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3120 skip |=
3121 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003122 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3123 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3124 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3125 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3126 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3127 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3128 "VUID-vkCmdBlitImage-srcSubresource-01707");
3129 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3130 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3131 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003132 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003133 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3134 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003135 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003136 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003137 skip |=
3138 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3139 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003140 }
Dave Houlton48989f32017-05-26 15:01:46 -06003141 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3142 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003143 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003144 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003145 skip |=
3146 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3147 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003148 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003149
3150 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003151 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003152 skip |= log_msg(
3153 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3154 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3155 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003156 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003157
Dave Houlton48989f32017-05-26 15:01:46 -06003158 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003159 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 -06003160 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003161 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003162 }
Dave Houlton48989f32017-05-26 15:01:46 -06003163
Dave Houlton33c2d252017-06-09 17:08:32 -06003164 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3165 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003166 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003167 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003168 "image format %s.",
3169 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003170 }
3171
3172 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3173 skip |= log_msg(
3174 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003175 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003176 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3177 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003178 }
3179
Dave Houlton48989f32017-05-26 15:01:46 -06003180 // Validate source image offsets
3181 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003182 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003183 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003184 skip |=
3185 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3186 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3187 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3188 "of (%1d, %1d). These must be (0, 1).",
3189 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003190 }
3191 }
3192
Dave Houlton33c2d252017-06-09 17:08:32 -06003193 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003194 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3195 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 -06003196 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003197 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003198 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3199 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003200 }
3201 }
3202
Dave Houlton33c2d252017-06-09 17:08:32 -06003203 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003204 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3205 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003206 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003207 skip |= log_msg(
3208 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3209 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3210 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3211 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003212 }
3213 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3214 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003215 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003216 skip |= log_msg(
3217 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003218 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003219 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003220 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003221 }
3222 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3223 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003224 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003225 skip |= log_msg(
3226 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3227 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3228 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3229 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003230 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003231 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003232 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 -06003233 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003234 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003235 }
Dave Houlton48989f32017-05-26 15:01:46 -06003236
3237 // Validate dest image offsets
3238 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003239 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003240 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003241 skip |=
3242 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3243 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3244 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3245 "(%1d, %1d). These must be (0, 1).",
3246 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003247 }
3248 }
3249
Dave Houlton33c2d252017-06-09 17:08:32 -06003250 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003251 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3252 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 -06003253 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003254 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003255 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3256 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003257 }
3258 }
3259
Dave Houlton33c2d252017-06-09 17:08:32 -06003260 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003261 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3262 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003263 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003264 skip |= log_msg(
3265 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3266 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3267 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3268 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003269 }
3270 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3271 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003272 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003273 skip |= log_msg(
3274 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003275 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003276 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003277 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003278 }
3279 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3280 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003281 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003282 skip |= log_msg(
3283 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3284 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3285 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3286 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003287 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003288 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003289 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 -06003290 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003291 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003292 }
3293
Dave Houlton33c2d252017-06-09 17:08:32 -06003294 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3295 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3296 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003297 skip |=
3298 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3299 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3300 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3301 "layerCount other than 1.",
3302 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003303 }
3304 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003305 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003306 } else {
3307 assert(0);
3308 }
3309 return skip;
3310}
3311
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003312void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3313 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3314 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003315 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003316 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003317 auto src_image_state = GetImageState(srcImage);
3318 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003319
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003320 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003321 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003322 SetImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3323 SetImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003324 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003325 // Update bindings between images and cmd buffer
3326 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3327 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003328}
3329
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003330// 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 -07003331bool CoreChecks::ValidateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003332 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3333 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003334 bool skip = false;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003335 for (auto cb_image_data : pCB->imageLayoutMap) {
3336 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003337
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003338 if (FindLayout(overlayLayoutMap, cb_image_data.first, imageLayout) ||
3339 FindLayout(globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003340 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3341 // TODO: Set memory invalid which is in mem_tracker currently
3342 } else if (imageLayout != cb_image_data.second.initialLayout) {
3343 if (cb_image_data.first.hasSubresource) {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003344 skip |=
3345 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3346 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07003347 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, mip level "
3348 "%u) to be in layout %s--instead, image %s's current layout is %s.",
3349 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3350 cb_image_data.first.subresource.aspectMask, cb_image_data.first.subresource.arrayLayer,
3351 cb_image_data.first.subresource.mipLevel, string_VkImageLayout(cb_image_data.second.initialLayout),
3352 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
3353 } else {
3354 skip |= log_msg(
3355 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3356 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3357 "Submitted command buffer expects image %s to be in layout %s--instead, image %s's current layout is %s.",
3358 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3359 string_VkImageLayout(cb_image_data.second.initialLayout),
3360 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003361 }
3362 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003363 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003364 }
3365 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003366 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003367}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003368
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003369void CoreChecks::UpdateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB) {
Tony Barbourdf013b92017-01-25 12:53:48 -07003370 for (auto cb_image_data : pCB->imageLayoutMap) {
3371 VkImageLayout imageLayout;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003372 FindGlobalLayout(cb_image_data.first, imageLayout);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003373 SetGlobalLayout(cb_image_data.first, cb_image_data.second.layout);
Tony Barbourdf013b92017-01-25 12:53:48 -07003374 }
3375}
3376
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003377// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003378// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3379// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003380bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3381 const VkImageLayout first_layout, const uint32_t attachment,
3382 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003383 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003384 const char *vuid;
3385 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3386
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003387 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3388 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003389 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3390 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3391 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003392 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003393 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3394 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3395 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3396 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3397 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3398 skip |=
3399 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3400 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003401 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003402 }
3403 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003404 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3405 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003406 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003407 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003408 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 -06003409 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003410 }
3411 }
3412
3413 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3414 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003415 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003416 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003417 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 -06003418 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003419 }
3420 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003421 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003422}
3423
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003424bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003425 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003426 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003427 const char *vuid;
3428 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3429 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003430
Jason Ekstranda1906302017-12-03 20:16:32 -08003431 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3432 VkFormat format = pCreateInfo->pAttachments[i].format;
3433 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3434 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3435 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003436 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 -06003437 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003438 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3439 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3440 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3441 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003442 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003443 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003444 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 -06003445 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003446 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3447 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3448 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3449 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003450 }
3451 }
3452 }
3453
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003454 // Track when we're observing the first use of an attachment
3455 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3456 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003457 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003458
3459 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3460 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3461 auto attach_index = subpass.pInputAttachments[j].attachment;
3462 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003463 switch (subpass.pInputAttachments[j].layout) {
3464 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3465 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3466 // These are ideal.
3467 break;
3468
3469 case VK_IMAGE_LAYOUT_GENERAL:
3470 // May not be optimal. TODO: reconsider this warning based on other constraints.
3471 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003472 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003473 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3474 break;
3475
Tobias Hectorbbb12282018-10-22 15:17:59 +01003476 case VK_IMAGE_LAYOUT_UNDEFINED:
3477 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3478 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3479 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3480 "Layout for input attachment reference %u in subpass %u is %s but must be "
3481 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3482 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3483 break;
3484
Graeme Leese668a9862018-10-08 10:40:02 +01003485 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3486 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003487 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003488 break;
3489 } else {
3490 // Intentionally fall through to generic error message
3491 }
3492 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003493
Cort Stratton7547f772017-05-04 15:18:52 -07003494 default:
3495 // No other layouts are acceptable
3496 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 -06003497 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003498 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3499 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3500 }
3501
Cort Stratton7547f772017-05-04 15:18:52 -07003502 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003503 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3504 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003505
3506 bool used_as_depth =
3507 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3508 bool used_as_color = false;
3509 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3510 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3511 }
3512 if (!used_as_depth && !used_as_color &&
3513 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003514 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3515 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3516 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3517 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003518 }
3519 }
3520 attach_first_use[attach_index] = false;
3521 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003522
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003523 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3524 auto attach_index = subpass.pColorAttachments[j].attachment;
3525 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3526
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003527 // TODO: Need a way to validate shared presentable images here, currently just allowing
3528 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3529 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003530 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003531 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003532 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003533 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3534 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003535 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003536
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003537 case VK_IMAGE_LAYOUT_GENERAL:
3538 // May not be optimal; TODO: reconsider this warning based on other constraints?
3539 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003540 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003541 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3542 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003543
Tobias Hectorbbb12282018-10-22 15:17:59 +01003544 case VK_IMAGE_LAYOUT_UNDEFINED:
3545 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3546 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3547 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3548 "Layout for color attachment reference %u in subpass %u is %s but should be "
3549 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3550 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3551 break;
3552
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003553 default:
3554 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 -06003555 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003556 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3557 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003558 }
3559
John Zulauf4eee2692019-02-09 16:14:25 -07003560 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3561 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3562 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003563 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3564 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 -07003565 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003566 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003567 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003568 }
3569
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003570 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003571 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3572 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003573 }
3574 attach_first_use[attach_index] = false;
3575 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003576
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003577 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3578 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003579 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3580 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3581 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003582 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003583
Dave Houltona9df0ce2018-02-07 10:51:23 -07003584 case VK_IMAGE_LAYOUT_GENERAL:
3585 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3586 // doing a bunch of transitions.
3587 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003588 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003589 "GENERAL layout for depth attachment may not give optimal performance.");
3590 break;
3591
Tobias Hectorbbb12282018-10-22 15:17:59 +01003592 case VK_IMAGE_LAYOUT_UNDEFINED:
3593 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3594 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3595 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3596 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3597 "layout or GENERAL.",
3598 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3599 break;
3600
Dave Houltona9df0ce2018-02-07 10:51:23 -07003601 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3602 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003603 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003604 break;
3605 } else {
3606 // Intentionally fall through to generic error message
3607 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003608 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003609
Dave Houltona9df0ce2018-02-07 10:51:23 -07003610 default:
3611 // No other layouts are acceptable
3612 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 -06003613 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003614 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3615 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3616 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003617 }
3618
3619 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3620 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003621 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3622 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003623 }
3624 attach_first_use[attach_index] = false;
3625 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003626 }
3627 return skip;
3628}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003629
3630// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003631bool CoreChecks::ValidateMapImageLayouts(VkDevice device, DEVICE_MEM_INFO const *mem_info, VkDeviceSize offset,
3632 VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003633 bool skip = false;
3634 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3635 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003636 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3637 for (auto image_handle : mem_info->bound_images) {
3638 auto img_it = mem_info->bound_ranges.find(image_handle);
3639 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003640 if (RangesIntersect(&img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003641 std::vector<VkImageLayout> layouts;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003642 if (FindLayouts(VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003643 for (auto layout : layouts) {
3644 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003645 skip |=
3646 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 -06003647 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003648 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3649 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003650 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003651 }
3652 }
3653 }
3654 }
3655 }
3656 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003657 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003658}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003659
3660// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3661// is true, verify that (actual & desired) flags == desired
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003662bool CoreChecks::ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict,
3663 uint64_t obj_handle, VulkanObjectType obj_type, const char *msgCode, char const *func_name,
3664 char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003665 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003666 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003667 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003668 if (strict) {
3669 correct_usage = ((actual & desired) == desired);
3670 } else {
3671 correct_usage = ((actual & desired) != 0);
3672 }
3673 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003674 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003675 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003676 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3677 kVUID_Core_MemTrack_InvalidUsageFlag,
3678 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3679 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003680 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003681 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3682 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3683 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003684 }
3685 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003686 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003687}
3688
3689// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3690// where an error will be flagged if usage is not correct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003691bool CoreChecks::ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
3692 const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003693 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3694 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003695}
3696
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003697bool CoreChecks::ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
3698 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003699 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003700 bool skip = false;
3701 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3702 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003703 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3704 HandleToUint64(image_state->image), linear_vuid,
3705 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3706 format_properties.linearTilingFeatures, image_state->createInfo.format,
3707 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003708 }
3709 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3710 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3711 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3712 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003713 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003714 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003715 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003716 }
3717 }
3718 return skip;
3719}
3720
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003721bool CoreChecks::ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3722 const VkImageSubresourceLayers *subresource_layers, char const *func_name,
3723 char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003724 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003725 // layerCount must not be zero
3726 if (subresource_layers->layerCount == 0) {
3727 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3728 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3729 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3730 }
3731 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3732 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3733 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3734 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3735 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3736 }
3737 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3738 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3739 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3740 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3741 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3742 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3743 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3744 func_name, i, member);
3745 }
3746 return skip;
3747}
3748
Mark Lobodzinski96210742017-02-09 10:33:46 -07003749// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3750// where an error will be flagged if usage is not correct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003751bool CoreChecks::ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired,
3752 bool strict, const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003753 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3754 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003755}
3756
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003757bool CoreChecks::ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3758 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003759 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003760
3761 const VkDeviceSize &range = pCreateInfo->range;
3762 if (range != VK_WHOLE_SIZE) {
3763 // Range must be greater than 0
3764 if (range <= 0) {
3765 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3766 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3767 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3768 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3769 range);
3770 }
3771 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003772 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003773 if (range % format_size != 0) {
3774 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3775 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3776 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3777 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3778 "(" PRINTF_SIZE_T_SPECIFIER ").",
3779 range, format_size);
3780 }
3781 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3782 if (range / format_size > device_limits->maxTexelBufferElements) {
3783 skip |=
3784 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3785 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3786 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3787 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3788 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3789 range, format_size, device_limits->maxTexelBufferElements);
3790 }
3791 // The sum of range and offset must be less than or equal to the size of buffer
3792 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3793 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3794 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3795 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3796 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3797 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3798 range, pCreateInfo->offset, buffer_state->createInfo.size);
3799 }
3800 }
3801 return skip;
3802}
3803
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003804bool CoreChecks::ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3805 const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003806 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003807 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003808 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3809 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3811 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3812 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3813 "be supported for uniform texel buffers");
3814 }
3815 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3816 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3817 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3818 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3819 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3820 "be supported for storage texel buffers");
3821 }
3822 return skip;
3823}
3824
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003825bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3826 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003827 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003828
Dave Houltond8ed0212018-05-16 17:18:24 -06003829 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003830
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003831 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures()->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003832 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 -06003833 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003834 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003835 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003836 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003837
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003838 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures()->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003839 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 -06003840 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003841 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003842 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003843 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003844
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003845 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003846 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 -06003847 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003848 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003849 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003850 }
Jeff Bolz87697532019-01-11 22:54:00 -06003851
3852 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3853 if (chained_devaddr_struct) {
3854 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3855 chained_devaddr_struct->deviceAddress != 0) {
3856 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3857 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3858 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3859 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3860 }
3861 }
3862
3863 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003864 !GetEnabledFeatures()->buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003865 skip |= log_msg(
3866 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3867 "VUID-VkBufferCreateInfo-flags-02605",
3868 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3869 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3870 }
3871
3872 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003873 !GetEnabledFeatures()->buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003874 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3875 "VUID-VkBufferCreateInfo-usage-02606",
3876 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3877 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3878 }
3879
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003880 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003881 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3882 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3883 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003884 }
3885
Mark Lobodzinski96210742017-02-09 10:33:46 -07003886 return skip;
3887}
3888
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003889void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3890 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003891 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003892 // 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 -07003893 GetBufferMap()->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003894}
3895
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003896bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3897 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003898 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3899
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003900 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003901 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003902 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3903 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003904 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003905 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3906 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003907 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3908 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3909 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3910 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003911
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003912 // Buffer view offset must be less than the size of buffer
3913 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3914 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3915 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3916 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3917 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3918 pCreateInfo->offset, buffer_state->createInfo.size);
3919 }
3920
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003921 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06003922 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3923 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3924 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3925 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3926 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3927 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3928 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3929 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003930
3931 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003932
3933 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003934 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003935 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003936}
3937
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003938void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3939 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003940 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07003941 (*GetBufferViewMap())[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003942}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003943
3944// For the given format verify that the aspect masks make sense
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003945bool CoreChecks::ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format,
3946 VkImageAspectFlags aspect_mask, const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003947 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003948 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3949 if (image != VK_NULL_HANDLE) {
3950 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3951 }
3952
Dave Houlton1d2022c2017-03-29 11:43:58 -06003953 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003954 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003955 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003956 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003957 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003958 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003959 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003960 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003961 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003962 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003963 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003964 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003965 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3966 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003967 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003968 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003969 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003970 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3971 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003972 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003973 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003974 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003975 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003976 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003977 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003978 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003979 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003980 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003981 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003982 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003983 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003984 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003985 } else if ((aspect_mask & 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 Lobodzinski487a0d12018-03-30 10:09:03 -06003987 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003988 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003989 } else if (FormatIsMultiplane(format)) {
3990 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3991 if (3 == FormatPlaneCount(format)) {
3992 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3993 }
3994 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003995 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003996 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3997 "set, where n = [0, 1, 2].",
3998 func_name);
3999 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004000 }
4001 return skip;
4002}
4003
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004004bool CoreChecks::ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count,
4005 const uint32_t image_layer_count, const VkImageSubresourceRange &subresourceRange,
4006 const char *cmd_name, const char *param_name, const char *image_layer_count_var_name,
4007 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004008 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004009
4010 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004011 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004012 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004013 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004014 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004015 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4016 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004017 }
Petr Kraus4d718682017-05-18 03:38:41 +02004018
Petr Krausffa94af2017-08-08 21:46:02 +02004019 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4020 if (subresourceRange.levelCount == 0) {
4021 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004022 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004023 } else {
4024 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004025
Petr Krausffa94af2017-08-08 21:46:02 +02004026 if (necessary_mip_count > image_mip_count) {
4027 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 -06004028 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004029 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004030 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004031 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004032 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004033 }
Petr Kraus4d718682017-05-18 03:38:41 +02004034 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004035 }
Petr Kraus4d718682017-05-18 03:38:41 +02004036
4037 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004038 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004039 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.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004041 "%s: %s.baseArrayLayer (= %" PRIu32
4042 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4043 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004044 }
Petr Kraus4d718682017-05-18 03:38:41 +02004045
Petr Krausffa94af2017-08-08 21:46:02 +02004046 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4047 if (subresourceRange.layerCount == 0) {
4048 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 -06004049 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004050 } else {
4051 const uint64_t necessary_layer_count =
4052 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004053
Petr Krausffa94af2017-08-08 21:46:02 +02004054 if (necessary_layer_count > image_layer_count) {
4055 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 -06004056 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004057 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004058 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004059 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004060 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004061 }
Petr Kraus4d718682017-05-18 03:38:41 +02004062 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004063 }
Petr Kraus4d718682017-05-18 03:38:41 +02004064
Mark Lobodzinski602de982017-02-09 11:01:33 -07004065 return skip;
4066}
4067
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004068bool CoreChecks::ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4069 bool is_imageview_2d_type,
4070 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004071 bool is_khr_maintenance1 = GetDeviceExtensions()->vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004072 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4073 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4074 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4075
4076 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4077 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4078
4079 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004080 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4081 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4082 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4083 : "VUID-VkImageViewCreateInfo-image-01482")
4084 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4085 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4086 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4087 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4088 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004089
4090 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4091 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4092 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4093}
4094
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004095bool CoreChecks::ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4096 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004097 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004098 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4099 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4100 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4101 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004102
4103 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4104 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4105 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4106}
4107
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004108bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4109 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004110 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004111 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4112 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4113 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4114 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004115
4116 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4117 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4118 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4119}
4120
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004121bool CoreChecks::ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4122 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4123 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004124 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004125 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4126 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4127 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4128 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004129
4130 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4131 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4132 subresourceRangeErrorCodes);
4133}
4134
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004135bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4136 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004137 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004138 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004139 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004140 if (image_state) {
4141 skip |= ValidateImageUsageFlags(
4142 device_data, image_state,
4143 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004144 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4145 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004146 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004147 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004148 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004149 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004150 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004151 skip |= ValidateCreateImageViewSubresourceRange(
4152 device_data, image_state,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004153 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4154 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004155
4156 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4157 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004158 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4159 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004160 VkFormat view_format = pCreateInfo->format;
4161 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004162 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004163 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004164
Dave Houltonbd2e2622018-04-10 16:41:14 -06004165 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004166 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004167 if (chained_ivuci_struct) {
4168 if (chained_ivuci_struct->usage & ~image_usage) {
4169 std::stringstream ss;
4170 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004171 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004172 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004173 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 -07004174 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004175 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004176 }
4177
4178 image_usage = chained_ivuci_struct->usage;
4179 }
4180
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004181 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4182 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004183 if (FormatIsMultiplane(image_format)) {
4184 // View format must match the multiplane compatible format
4185 uint32_t plane = 3; // invalid
4186 switch (aspect_mask) {
4187 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4188 plane = 0;
4189 break;
4190 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4191 plane = 1;
4192 break;
4193 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4194 plane = 2;
4195 break;
4196 default:
4197 break;
4198 }
4199
4200 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4201 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004202 std::stringstream ss;
4203 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004204 << " is not compatible with plane " << plane << " of underlying image format "
4205 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004206 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004207 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004208 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004209 }
4210 } else {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004211 if ((!GetDeviceExtensions()->vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004212 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4213 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4214 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4215 std::stringstream ss;
4216 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004217 << " is not in the same format compatibility class as image ("
4218 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004219 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4220 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004221 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 -07004222 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004223 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004224 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004225 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004226 }
4227 } else {
4228 // Format MUST be IDENTICAL to the format the image was created with
4229 if (image_format != view_format) {
4230 std::stringstream ss;
4231 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004232 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004233 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004234 skip |=
4235 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004236 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004237 }
4238 }
4239
4240 // Validate correct image aspect bits for desired formats and format consistency
4241 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004242
4243 switch (image_type) {
4244 case VK_IMAGE_TYPE_1D:
4245 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004246 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 -07004247 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004248 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4249 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004250 }
4251 break;
4252 case VK_IMAGE_TYPE_2D:
4253 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4254 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4255 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004256 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 -07004257 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004258 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4259 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004260 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004261 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 -07004262 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004263 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4264 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004265 }
4266 }
4267 break;
4268 case VK_IMAGE_TYPE_3D:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004269 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004270 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4271 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4272 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004273 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004274 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004275 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004276 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4277 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004278 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4279 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004280 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004281 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004282 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004283 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4284 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004285 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4286 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004287 }
4288 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004289 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004290 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004291 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4292 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004293 }
4294 }
4295 } else {
4296 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004297 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 -07004298 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004299 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4300 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004301 }
4302 }
4303 break;
4304 default:
4305 break;
4306 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004307
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004308 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004309 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004310 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004311 }
4312
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004313 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004314 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4315 : format_properties.optimalTilingFeatures;
4316
4317 if (tiling_features == 0) {
4318 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 -07004319 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004320 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4321 "physical device.",
4322 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4323 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4324 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 -07004325 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004326 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4327 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4328 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4329 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4330 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 -07004331 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004332 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4333 "VK_IMAGE_USAGE_STORAGE_BIT.",
4334 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4335 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4336 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
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-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004339 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4340 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4341 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4342 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4343 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4344 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 -07004345 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004346 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4347 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4348 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004349 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004350
Jeff Bolz9af91c52018-09-01 21:53:57 -05004351 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4352 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4353 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 -07004354 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004355 "vkCreateImageView() If image was created with usage containing "
4356 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4357 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4358 }
4359 if (view_format != VK_FORMAT_R8_UINT) {
4360 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 -07004361 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004362 "vkCreateImageView() If image was created with usage containing "
4363 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4364 }
4365 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004366 }
4367 return skip;
4368}
4369
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004370void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4371 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004372 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004373 auto image_view_map = GetImageViewMap();
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004374 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004375
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004376 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004377 auto &sub_res_range = (*image_view_map)[*pView].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004378 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4379 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004380}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004381
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004382bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4383 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004384 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004385 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004386 auto src_buffer_state = GetBufferState(srcBuffer);
4387 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004388
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004389 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004390 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4391 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004392 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004393 skip |=
4394 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4395 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4396 skip |=
4397 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4398 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004399 skip |=
4400 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4401 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004402 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004403 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004404 return skip;
4405}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004406
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004407void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4408 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004409 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004410 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004411 auto src_buffer_state = GetBufferState(srcBuffer);
4412 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004413
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004414 // Update bindings between buffers and cmd buffer
4415 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4416 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004417}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004418
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004419bool CoreChecks::ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004420 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004421 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004422 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004423 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 -07004424 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4425 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004426 } else {
4427 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004428 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 -06004429 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004430 "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 -07004431 }
4432 }
4433 return skip;
4434}
4435
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004436bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004437 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004438 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004439 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4440
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004441 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004442 if (image_view_state) {
4443 skip |= ValidateObjectNotInUse(device_data, image_view_state, obj_struct, "vkDestroyImageView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004444 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004445 }
4446 return skip;
4447}
4448
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004449void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004450 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004451 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004452 if (!image_view_state) return;
4453 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4454
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004455 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004456 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004457 (*GetImageViewMap()).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004458}
4459
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004460bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004461 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004462 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004463
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004464 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004465 if (buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004466 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004467 }
4468 return skip;
4469}
4470
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004471void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004472 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4473 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004474 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004475 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4476
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004477 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004478 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004479 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004480 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004481 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004482 }
4483 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004484 ClearMemoryObjectBindings(HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004485 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004486 GetBufferMap()->erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004487}
4488
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004489bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4490 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004491 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004492 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004493 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004494 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004495 if (buffer_view_state) {
4496 skip |= ValidateObjectNotInUse(device_data, buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004497 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004498 }
4499 return skip;
4500}
4501
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004502void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004503 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4504 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004505 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004506 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4507
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004508 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004509 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004510 GetBufferViewMap()->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004511}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004512
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004513bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4514 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004515 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004516 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004517 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004518 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004519 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004520 skip |=
4521 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4522 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004523 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4524 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004525 skip |=
4526 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4527 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004528 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004529 return skip;
4530}
4531
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004532void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4533 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004534 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004535 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004536 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004537 // Update bindings between buffer and cmd buffer
4538 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004539}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004540
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004541bool CoreChecks::ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount,
4542 const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004543 bool skip = false;
4544
4545 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004546 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4547 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004548 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 -06004549 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004550 "%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 -06004551 "and 1, respectively.",
4552 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004553 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004554 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004555
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004556 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4557 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004558 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 -06004559 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004560 "%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 -06004561 "must be 0 and 1, respectively.",
4562 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004563 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004564 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004565
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004566 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4567 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004568 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 -06004569 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004570 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4571 "For 3D images these must be 0 and 1, respectively.",
4572 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004573 }
4574 }
4575
4576 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004577 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
4578 uint32_t element_size = FormatElementSize(image_state->createInfo.format);
4579 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004580 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 -06004581 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004582 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004583 " must be a multiple of this format's texel size (%" PRIu32 ").",
4584 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004585 }
4586
4587 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004588 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004589 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004590 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004591 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4592 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004593 }
4594
4595 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4596 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004597 skip |=
4598 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004599 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004600 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4601 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004602 }
4603
4604 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4605 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4606 skip |= log_msg(
4607 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004608 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004609 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4610 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004611 }
4612
4613 // subresource aspectMask must have exactly 1 bit set
4614 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4615 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4616 if (aspect_mask_bits.count() != 1) {
4617 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 -06004618 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004619 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004620 }
4621
4622 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004623 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004624 skip |= log_msg(
4625 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004626 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004627 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4628 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004629 }
4630
4631 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004632 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004633 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004634
4635 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004636 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004637 skip |= log_msg(
4638 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-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004640 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4641 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004642 }
4643
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004644 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004645 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004646 skip |= log_msg(
4647 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004648 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004649 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4650 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004651 }
4652
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004653 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004654 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4655 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4656 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004657 skip |=
4658 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004659 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004660 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4661 "width & height (%d, %d)..",
4662 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004663 }
4664
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004665 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004666 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004667 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004668 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 -06004669 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004670 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004671 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004672 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004673 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004674
4675 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004676 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004677 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004678 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4679 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 -06004680 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004681 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004682 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004683 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004684 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004685 }
4686
4687 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004688 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004689 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4690 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 -06004691 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004692 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004693 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004694 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004695 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004696 }
4697
4698 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004699 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004700 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4701 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 -06004702 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004703 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004704 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004705 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004706 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004707 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004708 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004709 }
4710
4711 return skip;
4712}
4713
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004714static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004715 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004716 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004717 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004718
4719 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004720 VkExtent3D extent = pRegions[i].imageExtent;
4721 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004722
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004723 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4724 {
Dave Houlton51653902018-06-22 17:32:13 -06004725 skip |=
4726 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4727 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4728 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004729 }
4730
4731 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4732
4733 // 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 -06004734 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004735 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004736 if (image_extent.width % block_extent.width) {
4737 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4738 }
4739 if (image_extent.height % block_extent.height) {
4740 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4741 }
4742 if (image_extent.depth % block_extent.depth) {
4743 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4744 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004745 }
4746
Dave Houltonfc1a4052017-04-27 14:32:45 -06004747 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004748 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 -06004749 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004750 }
4751 }
4752
4753 return skip;
4754}
4755
Chris Forbese8ba09a2017-06-01 17:39:02 -07004756static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004757 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004758 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004759 bool skip = false;
4760
4761 VkDeviceSize buffer_size = buff_state->createInfo.size;
4762
4763 for (uint32_t i = 0; i < regionCount; i++) {
4764 VkExtent3D copy_extent = pRegions[i].imageExtent;
4765
4766 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4767 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houltona585d132019-01-18 13:05:42 -07004768 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004769
Dave Houltonf3229d52017-02-21 15:59:08 -07004770 // Handle special buffer packing rules for specific depth/stencil formats
4771 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houltona585d132019-01-18 13:05:42 -07004772 unit_size = FormatElementSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004773 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4774 switch (image_state->createInfo.format) {
4775 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004776 unit_size = FormatElementSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004777 break;
4778 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004779 unit_size = FormatElementSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004780 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004781 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004782 case VK_FORMAT_D24_UNORM_S8_UINT:
4783 unit_size = 4;
4784 break;
4785 default:
4786 break;
4787 }
4788 }
4789
Tom Cooperb2550c72018-10-15 13:08:41 +01004790 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004791 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004792 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004793 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4794 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4795
4796 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4797 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4798 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004799 }
4800
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004801 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4802 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4803 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004804 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004805 } else {
4806 // Calculate buffer offset of final copied byte, + 1.
4807 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4808 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4809 max_buffer_offset *= unit_size; // convert to bytes
4810 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004811
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004812 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004813 skip |=
4814 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4815 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004816 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004817 }
4818 }
4819
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004820 return skip;
4821}
4822
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004823bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4824 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004825 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004826 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004827 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004828 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004829
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004830 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4831
4832 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004833 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004834
4835 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004836 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004837
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004838 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004839
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004840 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4841 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 -06004842 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004843 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004844 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004845 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004846 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004847 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004848 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004849 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004850
4851 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004852 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004853 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4854 skip |=
4855 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004856
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004857 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004858 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4859 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4860 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004861 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004862 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4863 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004864 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04004865 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004866 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4867 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004868 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004869 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004870 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004871 const char *src_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004872 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004873 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4874 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004875 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004876 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4877 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004878 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004879 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4880 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004881 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004882 "vkCmdCopyImageToBuffer()",
4883 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004884 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4885 "vkCmdCopyImageToBuffer()", "imageSubresource",
4886 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4887 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4888 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4889 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004890 }
4891 return skip;
4892}
4893
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004894void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4895 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004896 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004897 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004898 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004899 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004900
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004901 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004902 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004903 SetImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004904 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004905 // Update bindings between buffer/image and cmd buffer
4906 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004907 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004908}
4909
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004910bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4911 VkImageLayout dstImageLayout, uint32_t regionCount,
4912 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004913 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004914 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004915 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004916 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004917
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004918 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4919
4920 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004921 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004922
4923 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004924 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004925 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004926 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4927 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 -06004928 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004929 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004930 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004931 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004932 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004933 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004934 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004935 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004936 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004937 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004938 skip |=
4939 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4940 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004941 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004942 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4943 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4944 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4945 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4946 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004947 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04004948 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004949 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4950 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004951 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004952 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004953 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004954 const char *dst_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004955 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004956 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4957 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004958 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004959 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4960 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004961 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004962 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4963 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004964 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004965 "vkCmdCopyBufferToImage()",
4966 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004967 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4968 "vkCmdCopyBufferToImage()", "imageSubresource",
4969 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4970 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4971 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4972 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004973 }
4974 return skip;
4975}
4976
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004977void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4978 VkImageLayout dstImageLayout, uint32_t regionCount,
4979 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004980 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004981 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004982 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004983 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004984
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004985 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004986 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004987 SetImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004988 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004989 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004990 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004991}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004992
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004993bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
4994 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004995 bool skip = false;
4996 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4997
Dave Houlton1d960ff2018-01-19 12:17:05 -07004998 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004999 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5000 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5001 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005002 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 -06005003 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005004 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005005 }
5006
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005007 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005008 if (!image_entry) {
5009 return skip;
5010 }
5011
Dave Houlton1d960ff2018-01-19 12:17:05 -07005012 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005013 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005014 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5015 "VUID-vkGetImageSubresourceLayout-image-00996",
5016 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005017 }
5018
Dave Houlton1d960ff2018-01-19 12:17:05 -07005019 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005020 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005021 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5022 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5023 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5024 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005025 }
5026
Dave Houlton1d960ff2018-01-19 12:17:05 -07005027 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005028 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005029 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5030 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5031 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5032 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005033 }
5034
Dave Houlton1d960ff2018-01-19 12:17:05 -07005035 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005036 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005037 if (FormatIsMultiplane(img_format)) {
5038 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005039 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005040 if (FormatPlaneCount(img_format) > 2u) {
5041 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005042 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005043 }
5044 if (sub_aspect != (sub_aspect & allowed_flags)) {
5045 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 -06005046 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005047 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005048 ") must be a single-plane specifier flag.",
5049 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005050 }
5051 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005052 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005053 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005054 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005055 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005056 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005057 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005058 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005059 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005060 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 -06005061 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005062 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005063 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005064 }
5065 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005066
Mark Lobodzinski60e79032019-03-07 10:22:31 -07005067 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005068 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005069 }
5070
Mike Weiblen672b58b2017-02-21 14:32:53 -07005071 return skip;
5072}