blob: 98c3ee27a71dad961ae0cb0ccfb9d6798a94e483 [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",
Locke7b4f9ac2019-04-01 10:58:17 -0600375 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
376 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 }
378
379 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
380 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
381 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
382 skip |=
383 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700384 "Layout/usage mismatch for attachment %u in render pass %s"
385 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100386 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600387 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
388 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100389 }
390
391 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
392 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
393 skip |=
394 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700395 "Layout/usage mismatch for attachment %u in render pass %s"
396 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100397 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600398 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
399 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100400 }
401
402 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
403 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
404 skip |=
405 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700406 "Layout/usage mismatch for attachment %u in render pass %s"
407 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100408 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600409 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
410 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100411 }
412
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700413 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100414 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
415 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
416 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
417 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
418 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
419 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700420 skip |= log_msg(
421 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
422 "Layout/usage mismatch for attachment %u in render pass %s"
423 " - the %s is %s but the image attached to framebuffer %s via image view %s"
424 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600425 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
426 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100427 }
428 } else {
429 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
430 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
431 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
432 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
433 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
434 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Lockee9aeebf2019-03-03 23:50:08 -0700435 "Layout/usage mismatch for attachment %u in render pass %s"
436 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100437 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600438 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
439 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700440 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100441 }
442 }
443 return skip;
444}
445
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700446bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
447 const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700448 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600449 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700450 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700451 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100452
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700453 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100454 auto framebuffer = framebuffer_state->framebuffer;
455
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700456 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600457 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -0600458 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700459 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700460 }
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
Piers Daniell10a5c762019-03-11 12:44:50 -06001413 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1414 !GetDeviceExtensions()->vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
1415 skip |= log_msg(
1416 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1417 "VUID-VkImageCreateInfo-format-02653",
1418 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1419 pCreateInfo->arrayLayers);
1420 }
1421
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001422 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1423 skip |=
1424 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1425 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001426 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001427 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001428 }
1429
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001430 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001431 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 -06001432 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001433 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1434 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001435 }
1436
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001437 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001438 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1439 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1440 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1441 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001442 skip |=
1443 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1444 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1445 "format must be block, ETC or ASTC compressed, but is %s",
1446 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001447 }
1448 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1449 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001450 skip |=
1451 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1452 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1453 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001454 }
1455 }
1456 }
1457
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001458 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001459 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1460 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1461 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001462 }
1463
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001464 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001465}
1466
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001467void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1468 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001469 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001470 IMAGE_LAYOUT_NODE image_state;
1471 image_state.layout = pCreateInfo->initialLayout;
1472 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001473 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001474 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001475 RecordCreateImageANDROID(pCreateInfo, is_node);
1476 }
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001477 GetImageMap()->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001478 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001479 (*GetImageSubresourceMap())[*pImage].push_back(subpair);
1480 (*GetImageLayoutMap())[subpair] = image_state;
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001481 (*GetImageLayoutMap())[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001482}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001483
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001484bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001485 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001486 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001487 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001488 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001489 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001490 }
1491 return skip;
1492}
1493
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001494void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001495 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001496 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001497 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001498 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001499 // Clean up memory mapping, bindings and range references for image
1500 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001501 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001502 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001503 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001504 }
1505 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001506 ClearMemoryObjectBindings(obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001507 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001508 // Remove image from imageMap
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001509 GetImageMap()->erase(image);
1510 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap = GetImageSubresourceMap();
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001511
1512 const auto &sub_entry = imageSubresourceMap->find(image);
1513 if (sub_entry != imageSubresourceMap->end()) {
1514 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001515 GetImageLayoutMap()->erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001516 }
1517 imageSubresourceMap->erase(sub_entry);
1518 }
1519}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001520
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001521bool CoreChecks::ValidateImageAttributes(IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001522 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001523
1524 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1525 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1526 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001527 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001528 }
1529
Dave Houlton1d2022c2017-03-29 11:43:58 -06001530 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001531 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1532 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001533 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001534 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001535 char const str[] = "vkCmdClearColorImage called with compressed image.";
1536 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001537 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001538 }
1539
1540 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1541 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1542 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001543 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001544 }
1545 return skip;
1546}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001547
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001548uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1549 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1550 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001551 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001552 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001553 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001554 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001555}
1556
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001557uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1558 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1559 uint32_t array_layer_count = range->layerCount;
1560 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1561 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001562 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001563 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001564}
1565
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001566bool CoreChecks::VerifyClearImageLayout(GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state, VkImageSubresourceRange range,
1567 VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001568 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001569
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001570 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1571 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001572
1573 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1574 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001575 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1576 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001577 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001578 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001579 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1580 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001581 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001582 if (!GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001583 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001584 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001585 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001586 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1587 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001588
1589 } else {
1590 if (image_state->shared_presentable) {
1591 skip |= log_msg(
1592 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001593 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001594 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1595 string_VkImageLayout(dest_image_layout));
1596 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001597 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001598 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001599 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001600 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001601 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001602 } else {
1603 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1604 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001605 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001606 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001607 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1608 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001609 }
1610 }
1611
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001612 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1613 uint32_t level = level_index + range.baseMipLevel;
1614 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1615 uint32_t layer = layer_index + range.baseArrayLayer;
1616 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001617 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001618 if (FindCmdBufLayout(cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001619 if (node.layout != dest_image_layout) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001620 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001621 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001622 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001623 } else {
1624 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1625 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001626 skip |=
1627 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1628 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1629 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001630 }
1631 }
1632 }
1633 }
1634
1635 return skip;
1636}
1637
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001638void CoreChecks::RecordClearImageLayout(GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1639 VkImageLayout dest_image_layout) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001640 VkImageCreateInfo *image_create_info = &(GetImageState(image)->createInfo);
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001641 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1642 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001644 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1645 uint32_t level = level_index + range.baseMipLevel;
1646 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1647 uint32_t layer = layer_index + range.baseArrayLayer;
1648 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001649 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001650 if (!FindCmdBufLayout(cb_node, image, sub, node)) {
1651 SetLayout(cb_node, image, sub, IMAGE_CMD_BUF_LAYOUT_NODE(dest_image_layout, dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001652 }
1653 }
1654 }
1655}
1656
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001657bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1658 const VkClearColorValue *pColor, uint32_t rangeCount,
1659 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001660 bool skip = false;
1661 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001662 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001663 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001664 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001665 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001666 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001667 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001668 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001669 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001670 skip |=
1671 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1672 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001673 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001674 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001675 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001676 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001677 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001678 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1679 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001680 }
1681 }
1682 return skip;
1683}
1684
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001685void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1686 const VkClearColorValue *pColor, uint32_t rangeCount,
1687 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001688 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001689 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001690 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001691 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001692 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001693 RecordClearImageLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001694 }
1695 }
1696}
1697
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001698bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1699 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1700 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001701 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001702
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001703 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001704 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001705 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001706 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001707 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001708 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001709 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001710 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001711 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001712 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001713 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1714 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001715 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001716 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001717 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001718 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001719 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001720 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001721 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001722 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001723 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1724 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001725 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001726 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1727 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001728 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 -06001729 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001730 }
1731 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001732 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001733 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001734 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 -06001735 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001736 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001737 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1738 char const str[] =
1739 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1740 "set.";
1741 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 -06001742 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001743 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001744 }
1745 return skip;
1746}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001747
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001748void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1749 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1750 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001751 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001752 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001753 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001754 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001755 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001756 RecordClearImageLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001757 }
1758 }
1759}
1760
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001761// Returns true if [x, xoffset] and [y, yoffset] overlap
1762static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1763 bool result = false;
1764 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1765 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1766
1767 if (intersection_max > intersection_min) {
1768 result = true;
1769 }
1770 return result;
1771}
1772
Dave Houltonc991cc92018-03-06 11:08:51 -07001773// Returns true if source area of first copy region intersects dest area of second region
1774// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1775static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001776 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001777
Dave Houltonc991cc92018-03-06 11:08:51 -07001778 // Separate planes within a multiplane image cannot intersect
1779 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001780 return result;
1781 }
1782
Dave Houltonc991cc92018-03-06 11:08:51 -07001783 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1784 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1785 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001786 result = true;
1787 switch (type) {
1788 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001789 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001790 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001791 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001792 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001793 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001794 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001795 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001796 break;
1797 default:
1798 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1799 assert(false);
1800 }
1801 }
1802 return result;
1803}
1804
Dave Houltonfc1a4052017-04-27 14:32:45 -06001805// Returns non-zero if offset and extent exceed image extents
1806static const uint32_t x_bit = 1;
1807static const uint32_t y_bit = 2;
1808static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001809static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001810 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001811 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001812 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1813 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001814 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001815 }
1816 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1817 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001818 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001819 }
1820 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1821 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001822 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001823 }
1824 return result;
1825}
1826
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001827// Test if two VkExtent3D structs are equivalent
1828static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1829 bool result = true;
1830 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1831 (extent->depth != other_extent->depth)) {
1832 result = false;
1833 }
1834 return result;
1835}
1836
Dave Houltonee281a52017-12-08 13:51:02 -07001837// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1838// Destination image texel extents must be adjusted by block size for the dest validation checks
1839VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1840 VkExtent3D adjusted_extent = extent;
1841 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001842 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001843 adjusted_extent.width /= block_size.width;
1844 adjusted_extent.height /= block_size.height;
1845 adjusted_extent.depth /= block_size.depth;
1846 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001847 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001848 adjusted_extent.width *= block_size.width;
1849 adjusted_extent.height *= block_size.height;
1850 adjusted_extent.depth *= block_size.depth;
1851 }
1852 return adjusted_extent;
1853}
1854
Dave Houlton6f9059e2017-05-02 17:15:13 -06001855// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001856static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1857 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001858
1859 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001860 if (mip >= img->createInfo.mipLevels) {
1861 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001862 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001863
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001864 // 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 -06001865 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001866
Dave Houltone48cd112019-01-03 17:01:18 -07001867 // If multi-plane, adjust per-plane extent
1868 if (FormatIsMultiplane(img->createInfo.format)) {
1869 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1870 extent.width /= divisors.width;
1871 extent.height /= divisors.height;
1872 }
1873
Jeff Bolzef40fec2018-09-01 22:04:34 -05001874 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1875 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001876 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001877 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1878 } else {
1879 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1880 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1881 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1882 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001883
Dave Houlton6f9059e2017-05-02 17:15:13 -06001884 // Image arrays have an effective z extent that isn't diminished by mip level
1885 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001886 extent.depth = img->createInfo.arrayLayers;
1887 }
1888
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001889 return extent;
1890}
1891
1892// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001893static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001894 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1895}
1896
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001897// Test if the extent argument has any dimensions set to 0.
1898static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1899 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1900}
1901
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001902// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001903VkExtent3D CoreChecks::GetScaledItg(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001904 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1905 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07001906 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001907 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001908 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001909 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001910 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001911 granularity.width *= block_size.width;
1912 granularity.height *= block_size.height;
1913 }
1914 }
1915 return granularity;
1916}
1917
1918// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1919static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1920 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001921 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1922 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001923 valid = false;
1924 }
1925 return valid;
1926}
1927
1928// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001929bool CoreChecks::CheckItgOffset(const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
1930 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001931 bool skip = false;
1932 VkExtent3D offset_extent = {};
1933 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1934 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1935 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001936 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001937 // 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 -07001938 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001939 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 -04001940 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001941 "%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 "
1942 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001943 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001944 }
1945 } else {
1946 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1947 // integer multiples of the image transfer granularity.
1948 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001949 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 -04001950 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001951 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1952 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001953 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1954 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001955 }
1956 }
1957 return skip;
1958}
1959
1960// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001961bool CoreChecks::CheckItgExtent(const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
1962 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
1963 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001964 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001965 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001966 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1967 // subresource extent.
1968 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001969 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 -04001970 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001971 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1972 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1973 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1974 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001975 }
1976 } else {
1977 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1978 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1979 // subresource extent dimensions.
1980 VkExtent3D offset_extent_sum = {};
1981 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1982 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1983 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001984 bool x_ok = true;
1985 bool y_ok = true;
1986 bool z_ok = true;
1987 switch (image_type) {
1988 case VK_IMAGE_TYPE_3D:
1989 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1990 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001991 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001992 case VK_IMAGE_TYPE_2D:
1993 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1994 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001995 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001996 case VK_IMAGE_TYPE_1D:
1997 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1998 (subresource_extent->width == offset_extent_sum.width));
1999 break;
2000 default:
2001 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2002 assert(false);
2003 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002004 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002005 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 -04002006 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002007 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2008 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2009 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2010 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2011 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2012 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002013 }
2014 }
2015 return skip;
2016}
2017
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002018bool CoreChecks::ValidateImageMipLevel(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level, const uint32_t i,
2019 const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002020 bool skip = false;
2021 if (mip_level >= img->createInfo.mipLevels) {
2022 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2023 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07002024 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
2025 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002026 }
2027 return skip;
2028}
2029
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002030bool CoreChecks::ValidateImageArrayLayerRange(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
2031 const uint32_t layer_count, const uint32_t i, const char *function,
2032 const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002033 bool skip = false;
2034 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2035 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2036 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2037 HandleToUint64(cb_node->commandBuffer), vuid,
2038 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07002039 "%u, but provided image %s has %u array layers.",
2040 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2041 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002042 }
2043 return skip;
2044}
2045
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002046// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002047bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2048 const VkBufferImageCopy *region, const uint32_t i,
2049 const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002050 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002051 VkExtent3D granularity = GetScaledItg(cb_node, img);
2052 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002053 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002054 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002055 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002056 return skip;
2057}
2058
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002059// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002060bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *src_img,
2061 const IMAGE_STATE *dst_img, const VkImageCopy *region,
2062 const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002063 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002064 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002065 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2066 skip |=
2067 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002068 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002069 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002070 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2071 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002072
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002073 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002074 granularity = GetScaledItg(cb_node, dst_img);
2075 skip |=
2076 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002077 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002078 const VkExtent3D dest_effective_extent =
2079 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002080 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002081 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002082 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002083 return skip;
2084}
2085
Dave Houlton6f9059e2017-05-02 17:15:13 -06002086// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002087bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002088 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002089 bool skip = false;
2090
2091 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002092 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002093
2094 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002095 const VkExtent3D src_copy_extent = region.extent;
2096 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002097 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2098
Dave Houlton6f9059e2017-05-02 17:15:13 -06002099 bool slice_override = false;
2100 uint32_t depth_slices = 0;
2101
2102 // Special case for copying between a 1D/2D array and a 3D image
2103 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2104 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002105 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002106 slice_override = (depth_slices != 1);
2107 } 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 -07002108 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002109 slice_override = (depth_slices != 1);
2110 }
2111
2112 // Do all checks on source image
2113 //
2114 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002115 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2116 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 -06002117 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002118 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002119 "be 0 and 1, respectively.",
2120 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002121 }
2122 }
2123
Dave Houlton533be9f2018-03-26 17:08:30 -06002124 // VUID-VkImageCopy-srcImage-01785
2125 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2126 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 -06002127 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002128 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002129 "these must be 0 and 1, respectively.",
2130 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002131 }
2132
Dave Houlton533be9f2018-03-26 17:08:30 -06002133 // VUID-VkImageCopy-srcImage-01787
2134 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2135 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 -06002136 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002137 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2138 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002139 }
2140
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002141 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002142 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002143 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002144 skip |=
2145 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002146 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002147 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002148 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2149 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002150 }
2151 }
2152 } else { // Pre maint 1
2153 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002154 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002155 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 -06002156 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002157 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2158 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002159 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2160 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002161 }
2162 }
2163 }
2164
Dave Houltonc991cc92018-03-06 11:08:51 -07002165 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002166 bool ext_ycbcr = GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002167 if (FormatIsCompressed(src_state->createInfo.format) ||
2168 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002169 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002170 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002171 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2172 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2173 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002174 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002175 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 -07002176 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002177 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002178 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002179 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002180 }
2181
Dave Houlton94a00372017-12-14 15:08:47 -07002182 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002183 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2184 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002185 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002186 skip |=
2187 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002188 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002189 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002190 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002191 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002192 }
2193
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002194 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002195 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2196 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002197 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002198 skip |=
2199 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002200 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002201 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002202 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002203 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002204 }
2205
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002206 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002207 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2208 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002209 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002210 skip |=
2211 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002212 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002213 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002214 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002215 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216 }
2217 } // Compressed
2218
2219 // Do all checks on dest image
2220 //
2221 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002222 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002223 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002224 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002225 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002226 "these must be 0 and 1, respectively.",
2227 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002228 }
2229 }
2230
Dave Houlton533be9f2018-03-26 17:08:30 -06002231 // VUID-VkImageCopy-dstImage-01786
2232 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2233 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 -06002234 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002235 "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 -06002236 "and 1, respectively.",
2237 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002238 }
2239
2240 // VUID-VkImageCopy-dstImage-01788
2241 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2242 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 -06002243 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002244 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2245 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002246 }
2247
2248 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002249 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002250 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 -06002251 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002252 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002253 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2254 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255 }
2256 }
2257 // VU01199 changed with mnt1
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002258 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002259 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002260 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002261 skip |=
2262 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002263 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002264 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002265 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2266 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 }
2268 }
2269 } else { // Pre maint 1
2270 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002271 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002272 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 -06002273 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002274 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2275 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002276 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2277 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002278 }
2279 }
2280 }
2281
Dave Houltonc991cc92018-03-06 11:08:51 -07002282 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2283 if (FormatIsCompressed(dst_state->createInfo.format) ||
2284 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002285 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002286
2287 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002288 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2289 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2290 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002291 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002292 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002293 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002294 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002295 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002296 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002297 }
2298
Dave Houlton94a00372017-12-14 15:08:47 -07002299 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002300 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2301 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002302 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002303 skip |=
2304 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002305 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002306 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002307 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002308 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002309 }
2310
Dave Houltonee281a52017-12-08 13:51:02 -07002311 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2312 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2313 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002314 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002315 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 -07002316 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002317 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2318 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002319 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002320 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002321 }
2322
Dave Houltonee281a52017-12-08 13:51:02 -07002323 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2324 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2325 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002326 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002327 skip |=
2328 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002329 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002330 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002331 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002332 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002333 }
2334 } // Compressed
2335 }
2336 return skip;
2337}
2338
Dave Houltonc991cc92018-03-06 11:08:51 -07002339// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002340bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2341 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002342 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002343
2344 // Neither image is multiplane
2345 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2346 // If neither image is multi-plane the aspectMask member of src and dst must match
2347 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2348 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002349 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002350 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2351 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 -06002352 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002353 }
2354 } else {
2355 // Source image multiplane checks
2356 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2357 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2358 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2359 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002360 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002361 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 -06002362 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002363 }
2364 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2365 (aspect != VK_IMAGE_ASPECT_PLANE_2_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 3-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-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002370 }
2371 // Single-plane to multi-plane
2372 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2373 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2374 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002375 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002376 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 -06002377 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002378 }
2379
2380 // Dest image multiplane checks
2381 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2382 aspect = region.dstSubresource.aspectMask;
2383 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2384 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002385 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002386 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 -06002387 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002388 }
2389 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2390 (aspect != VK_IMAGE_ASPECT_PLANE_2_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 3-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-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002395 }
2396 // Multi-plane to single-plane
2397 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2398 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2399 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002400 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002401 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 -06002402 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002403 }
2404 }
2405
2406 return skip;
2407}
2408
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002409bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2410 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2411 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002412 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002413 auto src_image_state = GetImageState(srcImage);
2414 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002415 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002416
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002417 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002418
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002419 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2420
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002421 for (uint32_t i = 0; i < regionCount; i++) {
2422 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002423
2424 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2425 VkExtent3D src_copy_extent = region.extent;
2426 VkExtent3D dst_copy_extent =
2427 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2428
Dave Houlton6f9059e2017-05-02 17:15:13 -06002429 bool slice_override = false;
2430 uint32_t depth_slices = 0;
2431
2432 // Special case for copying between a 1D/2D array and a 3D image
2433 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2434 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2435 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002436 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002437 slice_override = (depth_slices != 1);
2438 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2439 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002440 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002441 slice_override = (depth_slices != 1);
2442 }
2443
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002444 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2445 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2446 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002447 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002448 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002449 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002450 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002451 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2452 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002453 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002454 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2455 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002456
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002457 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002458 // No chance of mismatch if we're overriding depth slice count
2459 if (!slice_override) {
2460 // The number of depth slices in srcSubresource and dstSubresource must match
2461 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2462 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002463 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2464 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002465 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002466 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2467 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002468 if (src_slices != dst_slices) {
2469 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002470 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002471 << "] do not match";
2472 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 -06002473 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002474 }
2475 }
2476 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002477 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002478 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002479 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002480 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002481 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002482 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 -06002483 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002484 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002485 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002486
Dave Houltonc991cc92018-03-06 11:08:51 -07002487 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002488 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002489 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002490 }
2491
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002492 if (!GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002493 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2494 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002495 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002496 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 -06002497 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002498 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002499 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002500
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002501 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002502 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002503 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002504 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002505 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2506 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 -06002507 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002508 }
2509
2510 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002511 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002512 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002513 ss << "vkCmdCopyImage(): pRegion[" << i
2514 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002515 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 -06002516 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002517 }
2518
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002519 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2520 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2521 // 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 -07002522 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2523 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002524 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002525 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002526 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2527 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2528 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002529 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 -06002530 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002531 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002532
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002533 // 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 -07002534 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2535 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002536 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002537 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002538 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2539 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2540 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002541 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 -06002542 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002543 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002544 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002545
Dave Houltonfc1a4052017-04-27 14:32:45 -06002546 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002547 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2548 if (slice_override) src_copy_extent.depth = depth_slices;
2549 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002550 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002551 skip |=
2552 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2553 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2554 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2555 "width [%1d].",
2556 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002557 }
2558
2559 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002560 skip |=
2561 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2562 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2563 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2564 "height [%1d].",
2565 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002566 }
2567 if (extent_check & z_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-00147",
2571 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2572 "depth [%1d].",
2573 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002574 }
2575
Dave Houltonee281a52017-12-08 13:51:02 -07002576 // Adjust dest extent if necessary
2577 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2578 if (slice_override) dst_copy_extent.depth = depth_slices;
2579
2580 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002581 if (extent_check & x_bit) {
2582 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 -06002583 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002584 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002585 "width [%1d].",
2586 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002587 }
2588 if (extent_check & y_bit) {
2589 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002590 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002591 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002592 "height [%1d].",
2593 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002594 }
2595 if (extent_check & z_bit) {
2596 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 -06002597 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002598 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002599 "depth [%1d].",
2600 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002601 }
2602
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002603 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2604 // must not overlap in memory
2605 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002606 for (uint32_t j = 0; j < regionCount; j++) {
2607 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002608 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002609 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002610 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002611 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 -06002612 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002613 }
2614 }
2615 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002616 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002617
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002618 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2619 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2620 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002621 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002622 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2623 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002624 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 -06002625 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626 }
2627 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002628 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002629 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2630 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 -06002631 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002632 }
2633 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002634
Dave Houlton33c22b72017-02-28 13:16:02 -07002635 // Source and dest image sample counts must match
2636 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2637 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
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-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002640 }
2641
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002642 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2643 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002644 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002645 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2646 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2647 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2648 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07002649 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002650 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2651 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2652 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2653 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002654 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002655 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002656 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002657 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2658 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002659 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002660 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002661 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002662 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2663 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002664 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002665 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002666 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2667 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002668 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002669 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002670 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2671 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002672 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002673 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2674 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002675 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2676 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002677 }
2678
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002679 return skip;
2680}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002681
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002682void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2683 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2684 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002685 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002686 auto src_image_state = GetImageState(srcImage);
2687 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002688
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002689 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002690 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002691 SetImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2692 SetImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002693 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002694 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002695 AddCommandBufferBindingImage(cb_node, src_image_state);
2696 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002697}
2698
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002699// Returns true if sub_rect is entirely contained within rect
2700static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2701 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2702 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2703 return false;
2704 return true;
2705}
2706
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002707bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002708 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2709 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002710 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002711 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2712 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002713 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002714 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002715
2716 for (uint32_t j = 0; j < rect_count; j++) {
2717 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002718 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 -07002719 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2720 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2721 "the current render pass instance.",
2722 j);
2723 }
2724
2725 if (image_view_state) {
2726 // The layers specified by a given element of pRects must be contained within every attachment that
2727 // pAttachments refers to
2728 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2729 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2730 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002731 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2732 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2733 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2734 "of pAttachment[%d].",
2735 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002736 }
2737 }
2738 }
2739 return skip;
2740}
2741
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002742bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2743 const VkClearAttachment *pAttachments, uint32_t rectCount,
2744 const VkClearRect *pRects) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002745 GLOBAL_CB_NODE *cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002746
2747 bool skip = false;
2748 if (cb_node) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002749 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002750 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002751 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002752 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002753 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002754 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2755 // 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 -07002756 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2757 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002758 skip |=
2759 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2760 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2761 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2762 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2763 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002764 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002765 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002766 }
2767
2768 // Validate that attachment is in reference list of active subpass
2769 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002770 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002771 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002772 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002773 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002774 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2775 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002776
John Zulauf3a548ef2019-02-01 16:14:07 -07002777 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2778 auto clear_desc = &pAttachments[attachment_index];
2779 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002780
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002781 if (0 == clear_desc->aspectMask) {
2782 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 -06002783 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002784 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2785 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 -06002786 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002787 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002788 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2789 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2790 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2791 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002792 skip |= log_msg(
2793 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2794 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2795 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2796 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2797 attachment_index, clear_desc->colorAttachment,
2798 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2799 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2800
John Zulauff2582972019-02-09 14:53:30 -07002801 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2802 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002803 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002804 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2805 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2806 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2807 " subpass %u. colorAttachmentCount=%u",
2808 attachment_index, clear_desc->colorAttachment,
2809 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2810 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002811 }
John Zulauff2582972019-02-09 14:53:30 -07002812 fb_attachment = color_attachment;
2813
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002814 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2815 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2816 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002817 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002818 skip |=
2819 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2820 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002821 }
2822 } else { // Must be depth and/or stencil
2823 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2824 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002825 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002826 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 -07002827 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2828 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002829 }
2830 if (!subpass_desc->pDepthStencilAttachment ||
2831 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2832 skip |= log_msg(
2833 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002834 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002835 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002836 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002837 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002838 }
2839 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002840 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002841 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2842 rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002843 } else {
2844 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2845 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2846 if (!clear_rect_copy) {
2847 // We need a copy of the clear rectangles that will persist until the last lambda executes
2848 // but we want to create it as lazily as possible
2849 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002850 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002851
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002852 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauf3a548ef2019-02-01 16:14:07 -07002853 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2854 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002855 FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002856 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2857 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002858 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2859 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002860 return skip;
2861 };
2862 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002863 }
2864 }
2865 }
2866 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002867}
2868
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002869bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2870 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2871 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002872 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002873 auto src_image_state = GetImageState(srcImage);
2874 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002875
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002876 bool skip = false;
2877 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002878 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2879 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002880 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002881 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002882 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2883 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002884 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2885 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002886
Cort Stratton7df30962018-05-17 19:45:57 -07002887 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002888 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002889 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002890 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2891 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2892 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002893 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002894 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2895 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002896 // For each region, the number of layers in the image subresource should not be zero
2897 // For each region, src and dest image aspect must be color only
2898 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002899 skip |=
2900 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2901 skip |=
2902 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002903 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002904 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2905 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002906 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002907 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2908 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002909 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2910 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2911 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2912 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2913 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002914 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2915 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002916 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002917 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2918 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002919
2920 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002921 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2922 skip |= log_msg(
2923 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002924 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002925 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002926 }
Cort Stratton7df30962018-05-17 19:45:57 -07002927 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002928 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2929 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2930 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002931 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002932 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 -06002933 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002934 }
2935 }
2936
2937 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2938 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002939 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 -06002940 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002941 }
2942 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2943 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002944 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 -06002945 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002946 }
2947 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2948 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2949 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-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002951 }
2952 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2953 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2954 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 -06002955 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002956 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002957 } else {
2958 assert(0);
2959 }
2960 return skip;
2961}
2962
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002963void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2964 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2965 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002966 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002967 auto src_image_state = GetImageState(srcImage);
2968 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002969
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002970 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002971 AddCommandBufferBindingImage(cb_node, src_image_state);
2972 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002973}
2974
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002975bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2976 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2977 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002978 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002979 auto src_image_state = GetImageState(srcImage);
2980 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002981
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002982 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002983 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002984 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07002985 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002986 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002987 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002988 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002989 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002990 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002991 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2992 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06002993 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002994 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
2995 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06002996 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002997 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
2998 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002999 skip |=
3000 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003001 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3002 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003003 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003004 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003005 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003006 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003007
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003008 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003009
Dave Houlton33c2d252017-06-09 17:08:32 -06003010 VkFormat src_format = src_image_state->createInfo.format;
3011 VkFormat dst_format = dst_image_state->createInfo.format;
3012 VkImageType src_type = src_image_state->createInfo.imageType;
3013 VkImageType dst_type = dst_image_state->createInfo.imageType;
3014
Cort Stratton186b1a22018-05-01 20:18:06 -04003015 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003016 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003017 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3018 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003019 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003020 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3021 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3022 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003023 }
3024
3025 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3026 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 -06003027 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003028 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003029 }
3030
Dave Houlton33c2d252017-06-09 17:08:32 -06003031 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3032 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3033 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 -06003034 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003035 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003036 }
3037
3038 // Validate consistency for unsigned formats
3039 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3040 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003041 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003042 << "the other one must also have unsigned integer format. "
3043 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3044 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 -06003045 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003046 }
3047
3048 // Validate consistency for signed formats
3049 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3050 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003051 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003052 << "the other one must also have signed integer format. "
3053 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3054 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 -06003055 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003056 }
3057
3058 // Validate filter for Depth/Stencil formats
3059 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3060 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003061 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003062 << "then filter must be VK_FILTER_NEAREST.";
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-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003065 }
3066
3067 // Validate aspect bits and formats for depth/stencil images
3068 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3069 if (src_format != dst_format) {
3070 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003071 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003072 << "stencil, the other one must have exactly the same format. "
3073 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3074 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003075 skip |=
3076 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3077 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003078 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003079 } // Depth or Stencil
3080
3081 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003082 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003083 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003084 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3085 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3086 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003087 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003088 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3089 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003090 for (uint32_t i = 0; i < regionCount; i++) {
3091 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003092 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003093 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003094 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3095 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003096 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003097 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3098 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003099 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3100 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3101 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003102 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003103 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003104 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003105 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003106 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3107 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003108 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003109 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3110 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003111 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003112 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3113 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003114 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003115 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003116 skip |=
3117 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3118 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003119 }
Dave Houlton48989f32017-05-26 15:01:46 -06003120 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3121 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003122 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003123 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003124 skip |=
3125 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3126 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003127 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003128
3129 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003130 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003131 skip |= log_msg(
3132 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3133 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3134 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003135 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003136
Dave Houlton48989f32017-05-26 15:01:46 -06003137 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003138 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 -06003139 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003140 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003141 }
Dave Houlton48989f32017-05-26 15:01:46 -06003142
Dave Houlton33c2d252017-06-09 17:08:32 -06003143 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3144 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 -06003145 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003146 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003147 "image format %s.",
3148 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003149 }
3150
3151 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3152 skip |= log_msg(
3153 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003154 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003155 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3156 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003157 }
3158
Dave Houlton48989f32017-05-26 15:01:46 -06003159 // Validate source image offsets
3160 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003161 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003162 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003163 skip |=
3164 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3165 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3166 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3167 "of (%1d, %1d). These must be (0, 1).",
3168 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003169 }
3170 }
3171
Dave Houlton33c2d252017-06-09 17:08:32 -06003172 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003173 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3174 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 -06003175 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003176 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003177 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3178 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003179 }
3180 }
3181
Dave Houlton33c2d252017-06-09 17:08:32 -06003182 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003183 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3184 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003185 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003186 skip |= log_msg(
3187 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3188 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3189 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3190 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003191 }
3192 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3193 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003194 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003195 skip |= log_msg(
3196 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003197 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003198 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003199 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003200 }
3201 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3202 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003203 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003204 skip |= log_msg(
3205 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3206 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3207 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3208 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003209 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003210 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003211 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 -06003212 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003213 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003214 }
Dave Houlton48989f32017-05-26 15:01:46 -06003215
3216 // Validate dest image offsets
3217 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003218 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003219 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003220 skip |=
3221 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3222 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3223 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3224 "(%1d, %1d). These must be (0, 1).",
3225 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003226 }
3227 }
3228
Dave Houlton33c2d252017-06-09 17:08:32 -06003229 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003230 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3231 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 -06003232 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003233 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003234 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3235 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003236 }
3237 }
3238
Dave Houlton33c2d252017-06-09 17:08:32 -06003239 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003240 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3241 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003242 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003243 skip |= log_msg(
3244 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3245 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3246 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3247 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003248 }
3249 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3250 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003251 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003252 skip |= log_msg(
3253 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003254 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003255 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003256 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003257 }
3258 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3259 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003260 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003261 skip |= log_msg(
3262 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3263 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3264 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3265 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003266 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003267 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003268 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 -06003269 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003270 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003271 }
3272
Dave Houlton33c2d252017-06-09 17:08:32 -06003273 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3274 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3275 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003276 skip |=
3277 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3278 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3279 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3280 "layerCount other than 1.",
3281 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003282 }
3283 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003284 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003285 } else {
3286 assert(0);
3287 }
3288 return skip;
3289}
3290
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003291void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3292 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3293 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003294 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003295 auto src_image_state = GetImageState(srcImage);
3296 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003297
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003298 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003299 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003300 SetImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3301 SetImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003302 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003303 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003304 AddCommandBufferBindingImage(cb_node, src_image_state);
3305 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003306}
3307
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003308// 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 -07003309bool CoreChecks::ValidateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003310 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3311 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003312 bool skip = false;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003313 for (auto cb_image_data : pCB->imageLayoutMap) {
3314 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003315
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003316 if (FindLayout(overlayLayoutMap, cb_image_data.first, imageLayout) ||
3317 FindLayout(globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003318 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3319 // TODO: Set memory invalid which is in mem_tracker currently
3320 } else if (imageLayout != cb_image_data.second.initialLayout) {
3321 if (cb_image_data.first.hasSubresource) {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003322 skip |=
3323 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3324 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07003325 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, mip level "
3326 "%u) to be in layout %s--instead, image %s's current layout is %s.",
3327 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3328 cb_image_data.first.subresource.aspectMask, cb_image_data.first.subresource.arrayLayer,
3329 cb_image_data.first.subresource.mipLevel, string_VkImageLayout(cb_image_data.second.initialLayout),
3330 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
3331 } else {
3332 skip |= log_msg(
3333 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3334 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3335 "Submitted command buffer expects image %s to be in layout %s--instead, image %s's current layout is %s.",
3336 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3337 string_VkImageLayout(cb_image_data.second.initialLayout),
3338 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003339 }
3340 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003341 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003342 }
3343 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003344 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003345}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003346
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003347void CoreChecks::UpdateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB) {
Tony Barbourdf013b92017-01-25 12:53:48 -07003348 for (auto cb_image_data : pCB->imageLayoutMap) {
3349 VkImageLayout imageLayout;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003350 FindGlobalLayout(cb_image_data.first, imageLayout);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003351 SetGlobalLayout(cb_image_data.first, cb_image_data.second.layout);
Tony Barbourdf013b92017-01-25 12:53:48 -07003352 }
3353}
3354
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003355// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003356// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3357// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003358bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3359 const VkImageLayout first_layout, const uint32_t attachment,
3360 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003361 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003362 const char *vuid;
3363 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3364
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003365 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3366 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003367 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3368 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3369 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003370 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003371 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3372 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3373 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3374 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3375 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3376 skip |=
3377 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3378 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003379 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003380 }
3381 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003382 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3383 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003384 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003385 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003386 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 -06003387 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003388 }
3389 }
3390
3391 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3392 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003393 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003394 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003395 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 -06003396 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003397 }
3398 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003399 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003400}
3401
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003402bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003403 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003404 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003405 const char *vuid;
3406 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3407 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003408
Jason Ekstranda1906302017-12-03 20:16:32 -08003409 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3410 VkFormat format = pCreateInfo->pAttachments[i].format;
3411 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3412 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3413 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003414 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 -06003415 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003416 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3417 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3418 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3419 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003420 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003421 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003422 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 -06003423 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003424 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3425 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3426 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3427 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003428 }
3429 }
3430 }
3431
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003432 // Track when we're observing the first use of an attachment
3433 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3434 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003435 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003436
3437 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3438 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3439 auto attach_index = subpass.pInputAttachments[j].attachment;
3440 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003441 switch (subpass.pInputAttachments[j].layout) {
3442 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3443 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3444 // These are ideal.
3445 break;
3446
3447 case VK_IMAGE_LAYOUT_GENERAL:
3448 // May not be optimal. TODO: reconsider this warning based on other constraints.
3449 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003450 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003451 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3452 break;
3453
Tobias Hectorbbb12282018-10-22 15:17:59 +01003454 case VK_IMAGE_LAYOUT_UNDEFINED:
3455 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3456 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3457 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3458 "Layout for input attachment reference %u in subpass %u is %s but must be "
3459 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3460 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3461 break;
3462
Graeme Leese668a9862018-10-08 10:40:02 +01003463 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3464 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003465 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003466 break;
3467 } else {
3468 // Intentionally fall through to generic error message
3469 }
3470 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003471
Cort Stratton7547f772017-05-04 15:18:52 -07003472 default:
3473 // No other layouts are acceptable
3474 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 -06003475 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003476 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3477 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3478 }
3479
Cort Stratton7547f772017-05-04 15:18:52 -07003480 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003481 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3482 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003483
3484 bool used_as_depth =
3485 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3486 bool used_as_color = false;
3487 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3488 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3489 }
3490 if (!used_as_depth && !used_as_color &&
3491 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003492 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3493 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3494 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3495 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003496 }
3497 }
3498 attach_first_use[attach_index] = false;
3499 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003500
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003501 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3502 auto attach_index = subpass.pColorAttachments[j].attachment;
3503 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3504
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003505 // TODO: Need a way to validate shared presentable images here, currently just allowing
3506 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3507 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003508 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003509 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003510 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003511 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3512 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003513 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003514
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003515 case VK_IMAGE_LAYOUT_GENERAL:
3516 // May not be optimal; TODO: reconsider this warning based on other constraints?
3517 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003518 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003519 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3520 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003521
Tobias Hectorbbb12282018-10-22 15:17:59 +01003522 case VK_IMAGE_LAYOUT_UNDEFINED:
3523 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3524 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3525 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3526 "Layout for color attachment reference %u in subpass %u is %s but should be "
3527 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3528 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3529 break;
3530
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003531 default:
3532 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 -06003533 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003534 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3535 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003536 }
3537
John Zulauf4eee2692019-02-09 16:14:25 -07003538 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3539 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3540 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003541 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3542 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 -07003543 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003544 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003545 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003546 }
3547
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003548 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003549 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3550 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003551 }
3552 attach_first_use[attach_index] = false;
3553 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003554
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003555 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3556 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003557 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3558 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3559 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003560 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003561
Dave Houltona9df0ce2018-02-07 10:51:23 -07003562 case VK_IMAGE_LAYOUT_GENERAL:
3563 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3564 // doing a bunch of transitions.
3565 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003566 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003567 "GENERAL layout for depth attachment may not give optimal performance.");
3568 break;
3569
Tobias Hectorbbb12282018-10-22 15:17:59 +01003570 case VK_IMAGE_LAYOUT_UNDEFINED:
3571 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3572 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3573 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3574 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3575 "layout or GENERAL.",
3576 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3577 break;
3578
Dave Houltona9df0ce2018-02-07 10:51:23 -07003579 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3580 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003581 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003582 break;
3583 } else {
3584 // Intentionally fall through to generic error message
3585 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003586 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003587
Dave Houltona9df0ce2018-02-07 10:51:23 -07003588 default:
3589 // No other layouts are acceptable
3590 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 -06003591 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003592 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3593 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3594 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003595 }
3596
3597 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3598 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003599 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3600 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003601 }
3602 attach_first_use[attach_index] = false;
3603 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003604 }
3605 return skip;
3606}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003607
3608// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003609bool CoreChecks::ValidateMapImageLayouts(VkDevice device, DEVICE_MEM_INFO const *mem_info, VkDeviceSize offset,
3610 VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003611 bool skip = false;
3612 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3613 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003614 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3615 for (auto image_handle : mem_info->bound_images) {
3616 auto img_it = mem_info->bound_ranges.find(image_handle);
3617 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003618 if (RangesIntersect(&img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003619 std::vector<VkImageLayout> layouts;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003620 if (FindLayouts(VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003621 for (auto layout : layouts) {
3622 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003623 skip |=
3624 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 -06003625 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003626 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3627 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003628 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003629 }
3630 }
3631 }
3632 }
3633 }
3634 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003635 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003636}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003637
3638// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3639// is true, verify that (actual & desired) flags == desired
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003640bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3641 VulkanObjectType obj_type, const char *msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003642 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003643 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003644 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003645 if (strict) {
3646 correct_usage = ((actual & desired) == desired);
3647 } else {
3648 correct_usage = ((actual & desired) != 0);
3649 }
3650 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003651 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003652 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003653 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3654 kVUID_Core_MemTrack_InvalidUsageFlag,
3655 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3656 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003657 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003658 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3659 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3660 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003661 }
3662 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003663 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003664}
3665
3666// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3667// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003668bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
3669 char const *func_name, char const *usage_string) {
3670 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003671 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003672}
3673
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003674bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003675 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003676 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003677 bool skip = false;
3678 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3679 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003680 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3681 HandleToUint64(image_state->image), linear_vuid,
3682 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3683 format_properties.linearTilingFeatures, image_state->createInfo.format,
3684 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003685 }
3686 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3687 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3689 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003690 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003691 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003692 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003693 }
3694 }
3695 return skip;
3696}
3697
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003698bool CoreChecks::ValidateImageSubresourceLayers(const GLOBAL_CB_NODE *cb_node, const VkImageSubresourceLayers *subresource_layers,
3699 char const *func_name, char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003700 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003701 // layerCount must not be zero
3702 if (subresource_layers->layerCount == 0) {
3703 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3704 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3705 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3706 }
3707 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3708 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3709 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3710 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3711 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3712 }
3713 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3714 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3715 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3717 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3718 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3719 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3720 func_name, i, member);
3721 }
3722 return skip;
3723}
3724
Mark Lobodzinski96210742017-02-09 10:33:46 -07003725// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3726// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003727bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
3728 char const *func_name, char const *usage_string) {
3729 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003730 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003731}
3732
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003733bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3734 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003735 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003736
3737 const VkDeviceSize &range = pCreateInfo->range;
3738 if (range != VK_WHOLE_SIZE) {
3739 // Range must be greater than 0
3740 if (range <= 0) {
3741 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3742 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3743 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3744 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3745 range);
3746 }
3747 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003748 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003749 if (range % format_size != 0) {
3750 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3751 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3752 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3753 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3754 "(" PRINTF_SIZE_T_SPECIFIER ").",
3755 range, format_size);
3756 }
3757 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3758 if (range / format_size > device_limits->maxTexelBufferElements) {
3759 skip |=
3760 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3761 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3762 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3763 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3764 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3765 range, format_size, device_limits->maxTexelBufferElements);
3766 }
3767 // The sum of range and offset must be less than or equal to the size of buffer
3768 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3769 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3770 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3771 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3772 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3773 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3774 range, pCreateInfo->offset, buffer_state->createInfo.size);
3775 }
3776 }
3777 return skip;
3778}
3779
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003780bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003781 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003782 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003783 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3784 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3785 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3786 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3787 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3788 "be supported for uniform texel buffers");
3789 }
3790 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3791 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3792 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3793 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3794 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3795 "be supported for storage texel buffers");
3796 }
3797 return skip;
3798}
3799
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003800bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3801 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003802 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003803
Dave Houltond8ed0212018-05-16 17:18:24 -06003804 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003805
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003806 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures()->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003807 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 -06003808 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003809 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003810 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003811 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003812
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003813 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures()->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003814 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 -06003815 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003816 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003817 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003818 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003819
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003820 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003821 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 -06003822 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003823 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003824 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003825 }
Jeff Bolz87697532019-01-11 22:54:00 -06003826
3827 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3828 if (chained_devaddr_struct) {
3829 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3830 chained_devaddr_struct->deviceAddress != 0) {
3831 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3832 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3833 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3834 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3835 }
3836 }
3837
3838 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003839 !GetEnabledFeatures()->buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003840 skip |= log_msg(
3841 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3842 "VUID-VkBufferCreateInfo-flags-02605",
3843 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3844 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3845 }
3846
3847 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003848 !GetEnabledFeatures()->buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003849 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3850 "VUID-VkBufferCreateInfo-usage-02606",
3851 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3852 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3853 }
3854
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003855 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003856 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3857 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3858 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003859 }
3860
Mark Lobodzinski96210742017-02-09 10:33:46 -07003861 return skip;
3862}
3863
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003864void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3865 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003866 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003867 // 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 -07003868 GetBufferMap()->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003869}
3870
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003871bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3872 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003873 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003874 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003875 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3876 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003877 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003878 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3879 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003880 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06003881 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3882 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3883 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003884
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003885 // Buffer view offset must be less than the size of buffer
3886 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3887 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3888 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3889 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3890 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3891 pCreateInfo->offset, buffer_state->createInfo.size);
3892 }
3893
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003894 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06003895 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3896 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3897 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3898 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3899 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3900 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3901 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3902 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003903
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003904 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003905
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003906 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003907 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003908 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003909}
3910
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003911void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3912 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003913 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07003914 (*GetBufferViewMap())[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003915}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003916
3917// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003918bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
3919 const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003920 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003921 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3922 if (image != VK_NULL_HANDLE) {
3923 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3924 }
3925
Dave Houlton1d2022c2017-03-29 11:43:58 -06003926 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003927 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003928 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003929 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003930 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003931 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003932 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003933 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003934 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003935 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003936 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003937 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003938 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3939 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003940 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003941 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003942 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003943 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3944 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003945 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003946 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003947 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003948 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003949 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003950 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003951 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003952 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003953 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003954 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003955 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003956 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003957 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003958 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003959 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003960 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003961 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003962 } else if (FormatIsMultiplane(format)) {
3963 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3964 if (3 == FormatPlaneCount(format)) {
3965 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3966 }
3967 if ((aspect_mask & valid_flags) != 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,
Dave Houlton501b15b2018-03-30 15:07:41 -06003969 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3970 "set, where n = [0, 1, 2].",
3971 func_name);
3972 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003973 }
3974 return skip;
3975}
3976
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003977bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
3978 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3979 const char *param_name, const char *image_layer_count_var_name,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003980 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003981 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003982
3983 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003984 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003985 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 -06003986 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003987 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003988 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3989 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003990 }
Petr Kraus4d718682017-05-18 03:38:41 +02003991
Petr Krausffa94af2017-08-08 21:46:02 +02003992 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3993 if (subresourceRange.levelCount == 0) {
3994 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 -06003995 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003996 } else {
3997 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003998
Petr Krausffa94af2017-08-08 21:46:02 +02003999 if (necessary_mip_count > image_mip_count) {
4000 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004001 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004002 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004003 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004004 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004005 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004006 }
Petr Kraus4d718682017-05-18 03:38:41 +02004007 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004008 }
Petr Kraus4d718682017-05-18 03:38:41 +02004009
4010 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004011 if (subresourceRange.baseArrayLayer >= image_layer_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_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004014 "%s: %s.baseArrayLayer (= %" PRIu32
4015 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4016 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_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.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4020 if (subresourceRange.layerCount == 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.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004023 } else {
4024 const uint64_t necessary_layer_count =
4025 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004026
Petr Krausffa94af2017-08-08 21:46:02 +02004027 if (necessary_layer_count > image_layer_count) {
4028 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 -06004029 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004030 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004031 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004032 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004033 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004034 }
Petr Kraus4d718682017-05-18 03:38:41 +02004035 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004036 }
Petr Kraus4d718682017-05-18 03:38:41 +02004037
Mark Lobodzinski602de982017-02-09 11:01:33 -07004038 return skip;
4039}
4040
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004041bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004042 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004043 bool is_khr_maintenance1 = GetDeviceExtensions()->vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004044 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4045 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4046 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4047
4048 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4049 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4050
4051 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004052 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4053 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4054 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4055 : "VUID-VkImageViewCreateInfo-image-01482")
4056 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4057 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4058 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4059 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4060 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004061
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004062 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004063 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4064 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4065}
4066
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004067bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004068 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004069 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004070 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4071 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4072 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4073 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004074
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004075 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4076 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4077 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004078}
4079
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004080bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004081 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004082 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004083 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4084 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4085 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4086 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004087
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004088 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4089 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004090 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4091}
4092
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004093bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004094 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4095 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004096 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004097 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4098 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4099 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4100 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004101
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004102 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4103 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004104 subresourceRangeErrorCodes);
4105}
4106
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004107bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4108 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004109 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004110 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004111 if (image_state) {
4112 skip |= ValidateImageUsageFlags(
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004113 image_state,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004114 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004115 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4116 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004117 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004118 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004119 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004120 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004121 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004122 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004123 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004124 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004125
4126 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4127 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004128 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4129 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004130 VkFormat view_format = pCreateInfo->format;
4131 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004132 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004133 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004134
Dave Houltonbd2e2622018-04-10 16:41:14 -06004135 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004136 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004137 if (chained_ivuci_struct) {
4138 if (chained_ivuci_struct->usage & ~image_usage) {
4139 std::stringstream ss;
4140 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004141 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004142 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004143 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 -07004144 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004145 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004146 }
4147
4148 image_usage = chained_ivuci_struct->usage;
4149 }
4150
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004151 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4152 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004153 if (FormatIsMultiplane(image_format)) {
4154 // View format must match the multiplane compatible format
4155 uint32_t plane = 3; // invalid
4156 switch (aspect_mask) {
4157 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4158 plane = 0;
4159 break;
4160 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4161 plane = 1;
4162 break;
4163 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4164 plane = 2;
4165 break;
4166 default:
4167 break;
4168 }
4169
4170 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4171 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004172 std::stringstream ss;
4173 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004174 << " is not compatible with plane " << plane << " of underlying image format "
4175 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004176 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 -07004177 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004178 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004179 }
4180 } else {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004181 if ((!GetDeviceExtensions()->vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004182 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4183 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4184 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4185 std::stringstream ss;
4186 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004187 << " is not in the same format compatibility class as image ("
4188 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004189 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4190 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004191 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 -07004192 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004193 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004194 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004195 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004196 }
4197 } else {
4198 // Format MUST be IDENTICAL to the format the image was created with
4199 if (image_format != view_format) {
4200 std::stringstream ss;
4201 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004202 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004203 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004204 skip |=
4205 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004206 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004207 }
4208 }
4209
4210 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004211 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004212
4213 switch (image_type) {
4214 case VK_IMAGE_TYPE_1D:
4215 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004216 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 -07004217 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004218 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4219 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004220 }
4221 break;
4222 case VK_IMAGE_TYPE_2D:
4223 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4224 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4225 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004226 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 -07004227 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004228 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4229 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004230 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004231 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004232 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004233 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4234 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004235 }
4236 }
4237 break;
4238 case VK_IMAGE_TYPE_3D:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004239 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004240 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4241 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4242 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004243 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004244 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004245 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004246 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4247 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004248 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4249 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004250 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004251 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004252 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004253 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4254 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004255 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4256 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004257 }
4258 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004259 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 -07004260 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004261 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4262 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004263 }
4264 }
4265 } else {
4266 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004267 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 -07004268 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004269 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4270 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004271 }
4272 }
4273 break;
4274 default:
4275 break;
4276 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004277
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004278 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004279 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004280 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004281 }
4282
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004283 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004284 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4285 : format_properties.optimalTilingFeatures;
4286
4287 if (tiling_features == 0) {
4288 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 -07004289 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004290 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4291 "physical device.",
4292 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4293 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4294 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 -07004295 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004296 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4297 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4298 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4299 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4300 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 -07004301 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004302 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4303 "VK_IMAGE_USAGE_STORAGE_BIT.",
4304 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4305 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4306 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4307 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 -07004308 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004309 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4310 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4311 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4312 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4313 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4314 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 -07004315 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004316 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4317 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4318 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004319 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004320
Jeff Bolz9af91c52018-09-01 21:53:57 -05004321 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4322 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4323 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 -07004324 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004325 "vkCreateImageView() If image was created with usage containing "
4326 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4327 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4328 }
4329 if (view_format != VK_FORMAT_R8_UINT) {
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-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004332 "vkCreateImageView() If image was created with usage containing "
4333 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4334 }
4335 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004336 }
4337 return skip;
4338}
4339
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004340void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4341 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004342 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004343 auto image_view_map = GetImageViewMap();
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004344 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004345
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004346 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004347 auto &sub_res_range = (*image_view_map)[*pView].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004348 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4349 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004350}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004351
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004352bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4353 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004354 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004355 auto src_buffer_state = GetBufferState(srcBuffer);
4356 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004357
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004358 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004359 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4360 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004361 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004362 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004363 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4364 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004365 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004366 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4367 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004368 skip |=
4369 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4370 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004371 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4372 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004373 return skip;
4374}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004375
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004376void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4377 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004378 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004379 auto src_buffer_state = GetBufferState(srcBuffer);
4380 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004381
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004382 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004383 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4384 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004385}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004386
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004387bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004388 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004389 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004390 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004391 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 -07004392 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4393 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004394 } else {
4395 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004396 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 -06004397 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004398 "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 -07004399 }
4400 }
4401 return skip;
4402}
4403
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004404bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004405 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004406 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4407
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004408 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004409 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004410 skip |=
4411 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004412 }
4413 return skip;
4414}
4415
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004416void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004417 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004418 if (!image_view_state) return;
4419 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4420
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004421 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004422 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004423 (*GetImageViewMap()).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004424}
4425
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004426bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004427 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004428
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004429 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004430 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004431 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004432 }
4433 return skip;
4434}
4435
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004436void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004437 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004438 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004439 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4440
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004441 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004442 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004443 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004444 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004445 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004446 }
4447 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004448 ClearMemoryObjectBindings(HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004449 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004450 GetBufferMap()->erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004451}
4452
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004453bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4454 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004455 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004456 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004457 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004458 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004459 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004460 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004461 }
4462 return skip;
4463}
4464
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004465void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004466 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004467 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004468 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4469
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004470 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004471 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004472 GetBufferViewMap()->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004473}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004474
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004475bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4476 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004477 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004478 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004479 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004480 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004481 skip |=
4482 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4483 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004484 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004485 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004486 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4487 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004488 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004489 return skip;
4490}
4491
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004492void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4493 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004494 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004495 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004496 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004497 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004498}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004499
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004500bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4501 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004502 bool skip = false;
4503
4504 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004505 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4506 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004507 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 -06004508 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004509 "%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 -06004510 "and 1, respectively.",
4511 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004512 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004513 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004514
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004515 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4516 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004517 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004518 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004519 "%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 -06004520 "must be 0 and 1, respectively.",
4521 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004522 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004523 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004524
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004525 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4526 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004527 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 -06004528 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004529 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4530 "For 3D images these must be 0 and 1, respectively.",
4531 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004532 }
4533 }
4534
4535 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004536 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004537 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4538
Dave Houltona585d132019-01-18 13:05:42 -07004539 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004540 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 -06004541 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004542 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004543 " must be a multiple of this format's texel size (%" PRIu32 ").",
4544 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004545 }
4546
4547 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004548 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004549 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 -06004550 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004551 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4552 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004553 }
4554
4555 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4556 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004557 skip |=
4558 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-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004560 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4561 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004562 }
4563
4564 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4565 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4566 skip |= log_msg(
4567 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004568 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004569 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4570 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004571 }
4572
4573 // subresource aspectMask must have exactly 1 bit set
4574 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4575 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4576 if (aspect_mask_bits.count() != 1) {
4577 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 -06004578 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004579 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004580 }
4581
4582 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004583 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004584 skip |= log_msg(
4585 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004586 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004587 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4588 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004589 }
4590
4591 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004592 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004593 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004594
4595 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004596 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004597 skip |= log_msg(
4598 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-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004600 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4601 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004602 }
4603
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004604 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004605 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004606 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-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004609 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4610 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004611 }
4612
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004613 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004614 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4615 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4616 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004617 skip |=
4618 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004619 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004620 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4621 "width & height (%d, %d)..",
4622 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004623 }
4624
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004625 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004626 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004627 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004628 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 -06004629 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004630 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004631 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004632 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004633 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004634
4635 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004636 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004637 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004638 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4639 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 -06004640 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004641 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004642 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004643 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004644 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004645 }
4646
4647 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004648 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004649 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4650 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 -06004651 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004652 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004653 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004654 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004655 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004656 }
4657
4658 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004659 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004660 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4661 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 -06004662 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004663 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004664 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004665 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004666 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004667 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004668 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004669 }
4670
4671 return skip;
4672}
4673
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004674static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004675 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004676 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004677 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004678
4679 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004680 VkExtent3D extent = pRegions[i].imageExtent;
4681 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004682
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004683 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4684 {
Dave Houlton51653902018-06-22 17:32:13 -06004685 skip |=
4686 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4687 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4688 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004689 }
4690
4691 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4692
4693 // 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 -06004694 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004695 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004696 if (image_extent.width % block_extent.width) {
4697 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4698 }
4699 if (image_extent.height % block_extent.height) {
4700 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4701 }
4702 if (image_extent.depth % block_extent.depth) {
4703 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4704 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004705 }
4706
Dave Houltonfc1a4052017-04-27 14:32:45 -06004707 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004708 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 -06004709 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004710 }
4711 }
4712
4713 return skip;
4714}
4715
Chris Forbese8ba09a2017-06-01 17:39:02 -07004716static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004717 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004718 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004719 bool skip = false;
4720
4721 VkDeviceSize buffer_size = buff_state->createInfo.size;
4722
4723 for (uint32_t i = 0; i < regionCount; i++) {
4724 VkExtent3D copy_extent = pRegions[i].imageExtent;
4725
4726 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4727 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004728 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4729 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004730
Tom Cooperb2550c72018-10-15 13:08:41 +01004731 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004732 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004733 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004734 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4735 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4736
4737 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4738 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4739 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004740 }
4741
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004742 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4743 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4744 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004745 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004746 } else {
4747 // Calculate buffer offset of final copied byte, + 1.
4748 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4749 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4750 max_buffer_offset *= unit_size; // convert to bytes
4751 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004752
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004753 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004754 skip |=
4755 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4756 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004757 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004758 }
4759 }
4760
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004761 return skip;
4762}
4763
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004764bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4765 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004766 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004767 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004768 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004769
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004770 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004771
4772 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004773 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004774
4775 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004776 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004777
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004778 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004779
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004780 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4781 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 -06004782 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004783 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004784 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004785 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004786 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004787 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004788 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004789 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004790
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004791 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004792 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004793 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4794 skip |=
4795 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004796
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004797 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004798 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004799 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4800 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004801 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004802 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4803 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004804 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004805 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
4806 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004807 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004808 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004809 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004810 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004811 const char *src_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004812 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004813 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4814 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004815 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004816 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07004817 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004818 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004819 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4820 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004821 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4822 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
4823 skip |=
4824 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
4825 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4826 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004827 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4828 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004829 }
4830 return skip;
4831}
4832
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004833void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4834 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004835 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004836 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004837 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004838
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004839 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004840 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004841 SetImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004842 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004843 // Update bindings between buffer/image and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004844 AddCommandBufferBindingImage(cb_node, src_image_state);
4845 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004846}
4847
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004848bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4849 VkImageLayout dstImageLayout, uint32_t regionCount,
4850 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004851 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004852 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004853 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004854
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004855 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004856
4857 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004858 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004859
4860 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004861 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004862 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004863 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4864 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 -06004865 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004866 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004867 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004868 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004869 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004870 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004871 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004872 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004873 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004874 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004875 skip |=
4876 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4877 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004878 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004879 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4880 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004881 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004882 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4883 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004884 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004885 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
4886 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004887 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004888 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004889 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004890 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004891 const char *dst_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004892 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004893 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4894 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004895 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004896 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07004897 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004898 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004899 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4900 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004901 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4902 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
4903 skip |=
4904 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
4905 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4906 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004907 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4908 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004909 }
4910 return skip;
4911}
4912
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004913void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4914 VkImageLayout dstImageLayout, uint32_t regionCount,
4915 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004916 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004917 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004918 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004919
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004920 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004921 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004922 SetImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004923 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004924 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4925 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004926}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004927
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004928bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
4929 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004930 bool skip = false;
4931 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4932
Dave Houlton1d960ff2018-01-19 12:17:05 -07004933 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004934 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4935 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4936 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004937 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 -06004938 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004939 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004940 }
4941
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004942 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004943 if (!image_entry) {
4944 return skip;
4945 }
4946
Dave Houlton1d960ff2018-01-19 12:17:05 -07004947 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004948 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004949 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4950 "VUID-vkGetImageSubresourceLayout-image-00996",
4951 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004952 }
4953
Dave Houlton1d960ff2018-01-19 12:17:05 -07004954 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004955 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004956 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4957 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4958 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4959 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004960 }
4961
Dave Houlton1d960ff2018-01-19 12:17:05 -07004962 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004963 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004964 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4965 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4966 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4967 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004968 }
4969
Dave Houlton1d960ff2018-01-19 12:17:05 -07004970 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004971 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004972 if (FormatIsMultiplane(img_format)) {
4973 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004974 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004975 if (FormatPlaneCount(img_format) > 2u) {
4976 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004977 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004978 }
4979 if (sub_aspect != (sub_aspect & allowed_flags)) {
4980 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 -06004981 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004982 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004983 ") must be a single-plane specifier flag.",
4984 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004985 }
4986 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004987 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004988 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004989 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004990 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004991 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004992 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004993 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004994 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004995 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 -06004996 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004997 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004998 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004999 }
5000 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005001
Mark Lobodzinski60e79032019-03-07 10:22:31 -07005002 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005003 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005004 }
5005
Mike Weiblen672b58b2017-02-21 14:32:53 -07005006 return skip;
5007}