blob: 5030c08a95fae0ad2e93e1f369b64d88b3427838 [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 Lobodzinskib56bbb92019-02-18 11:49:59 -0700129bool CoreChecks::FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
130 const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700131 if (!(imgpair.subresource.aspectMask & aspectMask)) {
132 return false;
133 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700134 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
135 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700136 auto imgsubIt = (*GetImageLayoutMap()).find(imgpair);
137 if (imgsubIt == (*GetImageLayoutMap()).end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700138 return false;
139 }
140 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200141 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 -0600142 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700143 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
144 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700145 string_VkImageLayout(imgsubIt->second.layout));
146 }
147 layout = imgsubIt->second.layout;
148 return true;
149}
150
151// Find layout(s) on the command buffer level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700152bool CoreChecks::FindCmdBufLayout(GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700153 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700154 ImageSubresourcePair imgpair = {image, true, range};
155 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700156 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
157 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
158 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
159 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700160 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700161 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
162 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
163 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700164 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700165 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
166 imgpair = {image, false, VkImageSubresource()};
167 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
168 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
169 // TODO: This is ostensibly a find function but it changes state here
170 node = imgsubIt->second;
171 }
172 return true;
173}
174
175// Find layout(s) on the global level
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700176bool CoreChecks::FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700177 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
178 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
179 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
180 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
181 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700182 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700183 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
184 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
185 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
186 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700187 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
188 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700189 auto imgsubIt = (*GetImageLayoutMap()).find(imgpair);
190 if (imgsubIt == (*GetImageLayoutMap()).end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700191 layout = imgsubIt->second.layout;
192 }
193 return true;
194}
195
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700196bool CoreChecks::FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700197 auto sub_data = (*GetImageSubresourceMap()).find(image);
198 if (sub_data == (*GetImageSubresourceMap()).end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700199 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700200 if (!image_state) return false;
201 bool ignoreGlobal = false;
202 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
203 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
204 ignoreGlobal = true;
205 }
206 for (auto imgsubpair : sub_data->second) {
207 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700208 auto img_data = (*GetImageLayoutMap()).find(imgsubpair);
209 if (img_data != (*GetImageLayoutMap()).end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700210 layouts.push_back(img_data->second.layout);
211 }
212 }
213 return true;
214}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700215
216bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
217 ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700218 if (!(imgpair.subresource.aspectMask & aspectMask)) {
219 return false;
220 }
221 imgpair.subresource.aspectMask = aspectMask;
222 auto imgsubIt = imageLayoutMap.find(imgpair);
223 if (imgsubIt == imageLayoutMap.end()) {
224 return false;
225 }
226 layout = imgsubIt->second.layout;
227 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700228}
Tony Barbourdf013b92017-01-25 12:53:48 -0700229
230// find layout in supplied map
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700231bool CoreChecks::FindLayout(layer_data *device_data,
232 const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
233 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700234 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
235 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
236 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
237 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
238 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700239 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700240 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
241 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
242 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
243 }
244 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700245 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
246 imgpair = {imgpair.image, false, VkImageSubresource()};
247 auto imgsubIt = imageLayoutMap.find(imgpair);
248 if (imgsubIt == imageLayoutMap.end()) return false;
249 layout = imgsubIt->second.layout;
250 }
251 return true;
252}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700253
254// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700255void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700256 VkImage &image = imgpair.image;
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700257 auto &lmap = (*GetImageLayoutMap());
Dave Houltonb3f4b282018-02-22 16:25:16 -0700258 auto data = lmap.find(imgpair);
259 if (data != lmap.end()) {
260 data->second.layout = layout; // Update
261 } else {
262 lmap[imgpair].layout = layout; // Insert
263 }
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700264 auto &image_subresources = (*GetImageSubresourceMap())[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700265 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
266 if (subresource == image_subresources.end()) {
267 image_subresources.push_back(imgpair);
268 }
269}
270
271// Set the layout on the cmdbuf level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700272void CoreChecks::SetLayout(GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700273 auto it = pCB->imageLayoutMap.find(imgpair);
274 if (it != pCB->imageLayoutMap.end()) {
275 it->second = node; // Update
276 } else {
277 pCB->imageLayoutMap[imgpair] = node; // Insert
278 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700279}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600280// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700281void CoreChecks::SetImageLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700282 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600283 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700284 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600285 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
286 uint32_t level = image_subresource_range.baseMipLevel + level_index;
287 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
288 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
289 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700290 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
291 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600292 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600293 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700294 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
295 }
296 }
Tony-LunarG119b38a2018-12-18 09:49:16 -0700297 // For multiplane images, IMAGE_ASPECT_COLOR is an alias for all of the plane bits
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700298 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG119b38a2018-12-18 09:49:16 -0700299 if (FormatIsMultiplane(image_state->createInfo.format)) {
300 if (sub.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
301 sub.aspectMask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
302 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR;
303 if (FormatPlaneCount(image_state->createInfo.format) > 2) {
304 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
305 }
306 }
307 }
308 }
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700309 SetLayout(cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700310 }
311 }
312}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600313// Set image layout for given VkImageSubresourceLayers struct
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700314void CoreChecks::SetImageLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700315 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600316 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
317 VkImageSubresourceRange image_subresource_range;
318 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
319 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
320 image_subresource_range.layerCount = image_subresource_layers.layerCount;
321 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
322 image_subresource_range.levelCount = 1;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700323 SetImageLayout(cb_node, image_state, image_subresource_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600324}
Dave Houltonddd65c52018-05-08 14:58:01 -0600325
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600326// Set image layout for all slices of an image view
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700327void CoreChecks::SetImageViewLayout(GLOBAL_CB_NODE *cb_node, IMAGE_VIEW_STATE *view_state, const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600328 assert(view_state);
329
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700330 IMAGE_STATE *image_state = GetImageState(view_state->create_info.image);
Dave Houltonddd65c52018-05-08 14:58:01 -0600331 VkImageSubresourceRange sub_range = view_state->create_info.subresourceRange;
332
333 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
334 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
335 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state->create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
336 sub_range.baseArrayLayer = 0;
337 sub_range.layerCount = image_state->createInfo.extent.depth;
338 }
339
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700340 SetImageLayout(cb_node, image_state, sub_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600341}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700342
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700343void CoreChecks::SetImageViewLayout(GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700344 auto view_state = GetImageViewState(imageView);
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700345 SetImageViewLayout(cb_node, view_state, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600346}
347
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700348bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(layer_data *device_data, RenderPassCreateVersion rp_version,
349 VkImageLayout layout, VkImage image, VkImageView image_view,
350 VkFramebuffer framebuffer, VkRenderPass renderpass,
351 uint32_t attachment_index, const char *variable_name) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100352 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700353 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100354 const char *vuid;
355 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
356
357 if (!image_state) {
358 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
359 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Lockee9aeebf2019-03-03 23:50:08 -0700360 "Render Pass begin with renderpass %s uses framebuffer %s where pAttachments[%" PRIu32
361 "] = image view %s, which refers to an invalid image",
362 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
363 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100364 return skip;
365 }
366
367 auto image_usage = image_state->createInfo.usage;
368
369 // Check for layouts that mismatch image usages in the framebuffer
370 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
371 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
372 skip |=
373 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 -0700374 "Layout/usage mismatch for attachment %u in render pass %s"
375 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100376 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700377 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
378 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100379 }
380
381 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
382 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
383 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
384 skip |=
385 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 -0700386 "Layout/usage mismatch for attachment %u in render pass %s"
387 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100388 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700389 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
390 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100391 }
392
393 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
394 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
395 skip |=
396 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 -0700397 "Layout/usage mismatch for attachment %u in render pass %s"
398 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100399 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700400 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
401 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100402 }
403
404 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
405 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
406 skip |=
407 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 -0700408 "Layout/usage mismatch for attachment %u in render pass %s"
409 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100410 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700411 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
412 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100413 }
414
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700415 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100416 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
417 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
418 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
419 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
420 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
421 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700422 skip |= log_msg(
423 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
424 "Layout/usage mismatch for attachment %u in render pass %s"
425 " - the %s is %s but the image attached to framebuffer %s via image view %s"
426 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
427 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
428 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100429 }
430 } else {
431 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
432 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
433 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
434 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
435 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
436 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Lockee9aeebf2019-03-03 23:50:08 -0700437 "Layout/usage mismatch for attachment %u in render pass %s"
438 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100439 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700440 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name,
441 string_VkImageLayout(layout), report_data->FormatHandle(renderpass).c_str(),
442 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100443 }
444 }
445 return skip;
446}
447
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700448bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, RenderPassCreateVersion rp_version,
449 GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
450 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600451 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700452 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700453 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100454
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700455 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100456 auto framebuffer = framebuffer_state->framebuffer;
457
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700458 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600459 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 -0600460 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700461 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700462 }
463 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
464 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700465 auto view_state = GetImageViewState(image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600466
467 if (!view_state) {
Lockee9aeebf2019-03-03 23:50:08 -0700468 skip |=
469 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
470 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
471 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
472 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
473 report_data->FormatHandle(image_view).c_str());
John Zulauf8e308292018-09-21 11:34:37 -0600474 continue;
475 }
476
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700477 const VkImage &image = view_state->create_info.image;
478 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700479 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100480 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
481
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700482 // TODO: Do not iterate over every possibility - consolidate where possible
483 for (uint32_t j = 0; j < subRange.levelCount; j++) {
484 uint32_t level = subRange.baseMipLevel + j;
485 for (uint32_t k = 0; k < subRange.layerCount; k++) {
486 uint32_t layer = subRange.baseArrayLayer + k;
487 VkImageSubresource sub = {subRange.aspectMask, level, layer};
488 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700489 if (!FindCmdBufLayout(pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700490 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700491 continue;
492 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700493 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600494 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 -0600495 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700496 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
497 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
498 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600499 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700500 }
501 }
502 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100503
504 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, initial_layout, image, image_view,
505 framebuffer, render_pass, i, "initial layout");
506
507 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, final_layout, image, image_view, framebuffer,
508 render_pass, i, "final layout");
509 }
510
511 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
512 auto &subpass = pRenderPassInfo->pSubpasses[j];
513 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
514 auto &attachment_ref = subpass.pInputAttachments[k];
515 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
516 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700517 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100518
519 if (view_state) {
520 auto image = view_state->create_info.image;
521 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
522 image_view, framebuffer, render_pass,
523 attachment_ref.attachment, "input attachment layout");
524 }
525 }
526 }
527
528 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
529 auto &attachment_ref = subpass.pColorAttachments[k];
530 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
531 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700532 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100533
534 if (view_state) {
535 auto image = view_state->create_info.image;
536 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
537 image_view, framebuffer, render_pass,
538 attachment_ref.attachment, "color attachment layout");
539 if (subpass.pResolveAttachments) {
540 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
541 device_data, rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
542 attachment_ref.attachment, "resolve attachment layout");
543 }
544 }
545 }
546 }
547
548 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
549 auto &attachment_ref = *subpass.pDepthStencilAttachment;
550 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
551 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700552 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100553
554 if (view_state) {
555 auto image = view_state->create_info.image;
556 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
557 image_view, framebuffer, render_pass,
558 attachment_ref.attachment, "input attachment layout");
559 }
560 }
561 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700562 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600563 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700564}
565
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700566void CoreChecks::TransitionAttachmentRefLayout(GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700567 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700568 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700569 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600570 if (image_view) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700571 SetImageViewLayout(pCB, image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600572 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700573 }
574}
575
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700576void CoreChecks::TransitionSubpassLayouts(GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state, const int subpass_index,
577 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700578 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700579
580 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700581 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700582 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700583 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700584 }
585 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700586 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700587 }
588 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700589 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700590 }
591 }
592}
593
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700594bool CoreChecks::ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB,
595 const VkImageMemoryBarrier *mem_barrier, uint32_t level, uint32_t layer,
596 VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700597 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
598 return false;
599 }
600 VkImageSubresource sub = {aspect, level, layer};
601 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700602 if (!FindCmdBufLayout(pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700603 return false;
604 }
605 bool skip = false;
606 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
607 // TODO: Set memory invalid which is in mem_tracker currently
608 } else if (node.layout != mem_barrier->oldLayout) {
Lockee9aeebf2019-03-03 23:50:08 -0700609 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700610 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
611 HandleToUint64(pCB->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700612 "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 -0700613 report_data->FormatHandle(mem_barrier->image).c_str(), aspect, level, layer,
Lockee9aeebf2019-03-03 23:50:08 -0700614 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700615 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700616 return skip;
617}
618
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700619// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
620// 1. Transition into initialLayout state
621// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700622void CoreChecks::TransitionBeginRenderPassLayouts(GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700623 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700624 // First transition into initialLayout
625 auto const rpci = render_pass_state->createInfo.ptr();
626 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700627 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600628 if (view_state) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700629 SetImageViewLayout(cb_state, view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600630 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700631 }
632 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700633 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700634}
635
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700636void CoreChecks::TransitionImageAspectLayout(GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier, uint32_t level,
637 uint32_t layer, VkImageAspectFlags aspect_mask, VkImageAspectFlags aspect) {
Tony-LunarG0d27b302018-10-08 09:26:21 -0600638 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700639 return;
640 }
641 VkImageSubresource sub = {aspect, level, layer};
642 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700643 if (!FindCmdBufLayout(pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700644 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700645 SetLayout(pCB, mem_barrier->image, sub, IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700646 return;
647 }
648 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
649 // TODO: Set memory invalid
650 }
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700651 SetLayout(pCB, mem_barrier->image, sub, mem_barrier->newLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700652}
653
Dave Houlton10b39482017-03-16 13:18:15 -0600654bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600655 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600656 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600657 }
658 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600659 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600660 }
661 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600662 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600663 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700664 if (0 !=
665 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
666 if (FormatPlaneCount(format) == 1) return false;
667 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600668 return true;
669}
670
Mike Weiblen62d08a32017-03-07 22:18:27 -0700671// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700672bool CoreChecks::ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier,
673 bool new_not_old, VkImageUsageFlags usage_flags, const char *func_name) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700674 bool skip = false;
675 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600676 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677
678 switch (layout) {
679 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
680 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600681 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700682 }
683 break;
684 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
685 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600686 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700687 }
688 break;
689 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
690 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600691 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700692 }
693 break;
694 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
695 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600696 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700697 }
698 break;
699 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
700 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600701 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700702 }
703 break;
704 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
705 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600706 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700707 }
708 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600709 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500710 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
711 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
712 }
713 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700714 default:
715 // Other VkImageLayout values do not have VUs defined in this context.
716 break;
717 }
718
Dave Houlton8e9f6542018-05-18 12:18:22 -0600719 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600720 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 -0600721 HandleToUint64(img_barrier->image), msg_code,
Lockee9aeebf2019-03-03 23:50:08 -0700722 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image %s usage flags 0x%" PRIx32 ".", func_name,
723 static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
724 report_data->FormatHandle(img_barrier->image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700725 }
726 return skip;
727}
728
John Zulauf463c51e2018-05-31 13:29:20 -0600729// Scoreboard for checking for duplicate and inconsistent barriers to images
730struct ImageBarrierScoreboardEntry {
731 uint32_t index;
732 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
733 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
734 const VkImageMemoryBarrier *barrier;
735};
736using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
737using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
738
Mike Weiblen62d08a32017-03-07 22:18:27 -0700739// Verify image barriers are compatible with the images they reference.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700740bool CoreChecks::ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
741 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700742 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700743
John Zulauf463c51e2018-05-31 13:29:20 -0600744 // Scoreboard for duplicate layout transition barriers within the list
745 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
746 ImageBarrierScoreboardImageMap layout_transitions;
747
Mike Weiblen62d08a32017-03-07 22:18:27 -0700748 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
749 auto img_barrier = &pImageMemoryBarriers[i];
750 if (!img_barrier) continue;
751
John Zulauf463c51e2018-05-31 13:29:20 -0600752 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
753 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
754 // at a per sub-resource level
755 if (img_barrier->oldLayout != img_barrier->newLayout) {
756 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
757 auto image_it = layout_transitions.find(img_barrier->image);
758 if (image_it != layout_transitions.end()) {
759 auto &subres_map = image_it->second;
760 auto subres_it = subres_map.find(img_barrier->subresourceRange);
761 if (subres_it != subres_map.end()) {
762 auto &entry = subres_it->second;
763 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
764 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
765 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
766 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700767 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
768 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700769 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600770 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
771 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700772 func_name, i, entry.index, report_data->FormatHandle(img_barrier->image).c_str(), range.aspectMask,
Lockee9aeebf2019-03-03 23:50:08 -0700773 range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
774 string_VkImageLayout(img_barrier->oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600775 }
776 entry = new_entry;
777 } else {
778 subres_map[img_barrier->subresourceRange] = new_entry;
779 }
780 } else {
781 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
782 }
783 }
784
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700785 auto image_state = GetImageState(img_barrier->image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600786 if (image_state) {
787 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
788 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
789 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
790
791 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
792 if (image_state->layout_locked) {
793 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600794 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700795 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
796 HandleToUint64(img_barrier->image), 0,
Lockee9aeebf2019-03-03 23:50:08 -0700797 "Attempting to transition shared presentable image %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600798 " 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 -0700799 report_data->FormatHandle(img_barrier->image).c_str(), string_VkImageLayout(img_barrier->oldLayout),
800 string_VkImageLayout(img_barrier->newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600801 }
802 }
803
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700804 VkImageCreateInfo *image_create_info = &(GetImageState(img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600805 // For a Depth/Stencil image both aspects MUST be set
806 if (FormatIsDepthAndStencil(image_create_info->format)) {
807 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
808 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
809 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
811 HandleToUint64(img_barrier->image), "VUID-VkImageMemoryBarrier-image-01207",
Lockee9aeebf2019-03-03 23:50:08 -0700812 "%s: Image barrier 0x%p references image %s of format %s that must have the depth and stencil "
813 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
814 func_name, static_cast<const void *>(img_barrier),
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700815 report_data->FormatHandle(img_barrier->image).c_str(), string_VkFormat(image_create_info->format),
816 aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600817 }
818 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600819 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
820 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700821
Mike Weiblen62d08a32017-03-07 22:18:27 -0700822 for (uint32_t j = 0; j < level_count; j++) {
823 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
824 for (uint32_t k = 0; k < layer_count; k++) {
825 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600826 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
827 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
828 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
829 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700830 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700831 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
832 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
833 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
834 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
835 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
836 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
837 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700838 }
839 }
840 }
841 return skip;
842}
843
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700844bool CoreChecks::IsReleaseOp(GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600845 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700846
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700847 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700848 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700849}
850
John Zulauf6b4aae82018-05-09 13:03:36 -0600851template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700852bool CoreChecks::ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
853 uint32_t barrier_count, const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600854 using BarrierRecord = QFOTransferBarrier<Barrier>;
855 bool skip = false;
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700856 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600857 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
858 const char *barrier_name = BarrierRecord::BarrierName();
859 const char *handle_name = BarrierRecord::HandleName();
860 const char *transfer_type = nullptr;
861 for (uint32_t b = 0; b < barrier_count; b++) {
862 if (!IsTransferOp(&barriers[b])) continue;
863 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700864 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
865 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600866 const auto found = barrier_sets.release.find(barriers[b]);
867 if (found != barrier_sets.release.cend()) {
868 barrier_record = &(*found);
869 transfer_type = "releasing";
870 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600871 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
872 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600873 const auto found = barrier_sets.acquire.find(barriers[b]);
874 if (found != barrier_sets.acquire.cend()) {
875 barrier_record = &(*found);
876 transfer_type = "acquiring";
877 }
878 }
879 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700880 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
881 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
882 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
883 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
884 func_name, barrier_name, b, transfer_type, handle_name,
885 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
886 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600887 }
888 }
889 return skip;
890}
891
892template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700893void CoreChecks::RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count,
894 const Barrier *barriers) {
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700895 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600896 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
897 for (uint32_t b = 0; b < barrier_count; b++) {
898 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700899 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
900 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600901 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600902 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
903 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600904 barrier_sets.acquire.emplace(barriers[b]);
905 }
906 }
907}
908
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700909bool CoreChecks::ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
910 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
911 uint32_t imageMemBarrierCount,
912 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600913 bool skip = false;
914 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
915 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
916 return skip;
917}
918
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700919void CoreChecks::RecordBarriersQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
920 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
921 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600922 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
923 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
924}
925
926template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700927bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
928 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600929 // Record to the scoreboard or report that we have a duplication
930 bool skip = false;
931 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
932 if (!inserted.second && inserted.first->second != cb_state) {
933 // 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 -0700934 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
935 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
936 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
937 " duplicates existing barrier submitted in this batch from command buffer %s.",
938 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
939 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
940 report_data->FormatHandle(inserted.first->second).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600941 }
942 return skip;
943}
944
945template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700946bool CoreChecks::ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
947 QFOTransferCBScoreboards<Barrier> *scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600948 using BarrierRecord = QFOTransferBarrier<Barrier>;
949 using TypeTag = typename BarrierRecord::Tag;
950 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600951 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700952 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600953 const char *barrier_name = BarrierRecord::BarrierName();
954 const char *handle_name = BarrierRecord::HandleName();
955 // No release should have an extant duplicate (WARNING)
956 for (const auto &release : cb_barriers.release) {
957 // Check the global pending release barriers
958 const auto set_it = global_release_barriers.find(release.handle);
959 if (set_it != global_release_barriers.cend()) {
960 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
961 const auto found = set_for_handle.find(release);
962 if (found != set_for_handle.cend()) {
963 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
964 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700965 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600966 " to dstQueueFamilyIndex %" PRIu32
967 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700968 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600969 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
970 }
971 }
972 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
973 }
974 // Each acquire must have a matching release (ERROR)
975 for (const auto &acquire : cb_barriers.acquire) {
976 const auto set_it = global_release_barriers.find(acquire.handle);
977 bool matching_release_found = false;
978 if (set_it != global_release_barriers.cend()) {
979 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
980 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
981 }
982 if (!matching_release_found) {
983 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
984 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700985 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
986 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
987 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600988 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
989 }
990 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
991 }
992 return skip;
993}
994
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700995bool CoreChecks::ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
996 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
997 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600998 bool skip = false;
999 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
1000 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
1001 return skip;
1002}
1003
1004template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001005void CoreChecks::RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001006 using BarrierRecord = QFOTransferBarrier<Barrier>;
1007 using TypeTag = typename BarrierRecord::Tag;
1008 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001009 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001010
1011 // Add release barriers from this submit to the global map
1012 for (const auto &release : cb_barriers.release) {
1013 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1014 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1015 global_release_barriers[release.handle].insert(release);
1016 }
1017
1018 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1019 for (const auto &acquire : cb_barriers.acquire) {
1020 // NOTE: We're not using [] because we don't want to create entries for missing releases
1021 auto set_it = global_release_barriers.find(acquire.handle);
1022 if (set_it != global_release_barriers.end()) {
1023 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1024 set_for_handle.erase(acquire);
1025 if (set_for_handle.size() == 0) { // Clean up empty sets
1026 global_release_barriers.erase(set_it);
1027 }
1028 }
1029 }
1030}
1031
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001032void CoreChecks::RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001033 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1034 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1035}
1036
John Zulauf6b4aae82018-05-09 13:03:36 -06001037// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001038void CoreChecks::EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001039 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1040}
1041
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001042void CoreChecks::TransitionImageLayouts(GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001043 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001044 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1045 auto mem_barrier = &pImgMemBarriers[i];
1046 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001047
Chris Forbes4de4b132017-08-21 11:27:08 -07001048 // For ownership transfers, the barrier is specified twice; as a release
1049 // operation on the yielding queue family, and as an acquire operation
1050 // on the acquiring queue family. This barrier may also include a layout
1051 // transition, which occurs 'between' the two operations. For validation
1052 // purposes it doesn't seem important which side performs the layout
1053 // transition, but it must not be performed twice. We'll arbitrarily
1054 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001055 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001056 continue;
1057 }
1058
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001059 VkImageCreateInfo *image_create_info = &(GetImageState(mem_barrier->image)->createInfo);
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001060 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1061 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1062
Dave Houltonb3f4b282018-02-22 16:25:16 -07001063 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1064 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1065 // for all (potential) layer sub_resources.
1066 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1067 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1068 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1069 }
1070
Tony-LunarG0d27b302018-10-08 09:26:21 -06001071 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1072 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001073 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001074 if (FormatIsMultiplane(image_create_info->format)) {
1075 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1076 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1077 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1078 if (FormatPlaneCount(image_create_info->format) > 2) {
1079 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1080 }
1081 }
1082 }
1083 }
1084
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001085 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001086 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001087 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001088 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001089 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_COLOR_BIT);
1090 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_DEPTH_BIT);
1091 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_STENCIL_BIT);
1092 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001093 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001094 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1095 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1096 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001097 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001098 }
1099 }
1100 }
1101}
1102
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001103bool CoreChecks::VerifyImageLayout(GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state, VkImageSubresourceLayers subLayers,
1104 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1105 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001106 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001107 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001108
1109 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1110 uint32_t layer = i + subLayers.baseArrayLayer;
1111 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1112 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001113 if (FindCmdBufLayout(cb_node, image, sub, node)) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001114 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001115 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001116 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1117 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001118 "%s: Cannot use image %s (layer=%u mip=%u) with specific layout %s that doesn't match the actual "
1119 "current layout %s.",
1120 caller, report_data->FormatHandle(image).c_str(), layer, subLayers.mipLevel,
1121 string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001122 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001123 }
1124 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001125 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1126 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1127 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001128 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1129 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001130 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001131 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001132 kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07001133 "%s: For optimal performance image %s layout should be %s instead of GENERAL.", caller,
1134 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001135 }
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001136 } else if (GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001137 if (image_state->shared_presentable) {
1138 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001139 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1140 layout_invalid_msg_code,
1141 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1142 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001143 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001144 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001145 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001146 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001147 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 -07001148 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001149 "%s: Layout for image %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1150 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1151 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001152 }
1153 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001154 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001155}
1156
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001157void CoreChecks::TransitionFinalSubpassLayouts(GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001158 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001159 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001160 if (!renderPass) return;
1161
Tobias Hectorbbb12282018-10-22 15:17:59 +01001162 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001163 if (framebuffer_state) {
1164 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001165 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001166 if (view_state) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001167 SetImageViewLayout(pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001168 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001169 }
1170 }
1171}
Dave Houltone19e20d2018-02-02 16:32:41 -07001172
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001173#ifdef VK_USE_PLATFORM_ANDROID_KHR
1174// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1175// This could also move into a seperate core_validation_android.cpp file... ?
1176
1177//
1178// AHB-specific validation within non-AHB APIs
1179//
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001180bool CoreChecks::ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1181 const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001182 bool skip = false;
1183
1184 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1185 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001186 if (0 != ext_fmt_android->externalFormat) {
1187 if (VK_FORMAT_UNDEFINED != create_info->format) {
1188 skip |=
1189 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1190 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001191 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001192 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1193 }
1194
1195 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1196 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1197 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001198 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001199 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1200 }
1201
1202 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1203 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1204 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001205 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001206 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1207 }
1208
1209 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1210 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1211 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001212 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001213 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1214 }
1215 }
1216
Mark Lobodzinskieb8654d2019-03-07 11:14:47 -07001217 auto ahb_formats = GetAHBExternalFormatsSet();
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001218 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1219 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1220 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001221 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001222 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1223 }
1224 }
1225
Dave Houltond9611312018-11-19 17:03:36 -07001226 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001227 if (VK_FORMAT_UNDEFINED == create_info->format) {
1228 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1229 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001230 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001231 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1232 }
1233 }
1234
1235 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1236 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1237 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001238 skip |=
1239 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1240 "VUID-VkImageCreateInfo-pNext-02393",
1241 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1242 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1243 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001244 }
1245
1246 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1247 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1248 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001249 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001250 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1251 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1252 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1253 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001254 }
1255
1256 return skip;
1257}
1258
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001259void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001260 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1261 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1262 is_node->imported_ahb = true;
1263 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001264 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001265 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001266 is_node->has_ahb_format = true;
1267 is_node->ahb_format = ext_fmt_android->externalFormat;
1268 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001269}
1270
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001271bool CoreChecks::ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001272 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001273 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001274
1275 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001276 if (VK_FORMAT_UNDEFINED != create_info->format) {
1277 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1278 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1279 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1280 "format member is %s.",
1281 string_VkFormat(create_info->format));
1282 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001283
Dave Houltond9611312018-11-19 17:03:36 -07001284 // Chain must include a compatible ycbcr conversion
1285 bool conv_found = false;
1286 uint64_t external_format = 0;
1287 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1288 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001289 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskieb8654d2019-03-07 11:14:47 -07001290 auto fmap = GetYcbcrConversionFormatMap();
Dave Houltond9611312018-11-19 17:03:36 -07001291 if (fmap->find(conv_handle) != fmap->end()) {
1292 conv_found = true;
1293 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001294 }
Dave Houltond9611312018-11-19 17:03:36 -07001295 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001296 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001297 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 -07001298 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1299 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1300 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1301 }
1302
1303 // Errors in create_info swizzles
1304 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1305 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1306 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1307 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1308 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1309 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1310 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1311 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001312 }
1313 }
Dave Houltond9611312018-11-19 17:03:36 -07001314
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001315 return skip;
1316}
1317
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001318bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001319 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001320
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001321 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001322 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1323 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1324 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001325 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001326 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1327 "bound to memory.");
1328 }
1329 return skip;
1330}
1331
1332#else
1333
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001334bool CoreChecks::ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1335 const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001336 return false;
1337}
1338
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001339void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001340
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001341bool CoreChecks::ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001342
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001343bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001344
1345#endif // VK_USE_PLATFORM_ANDROID_KHR
1346
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001347bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1348 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
1349 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001350 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001351
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001352 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001353 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1354 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1355 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1356 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1357 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001358 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001359 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001360 }
1361
Dave Houlton130c0212018-01-29 13:39:56 -07001362 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001363 skip |= log_msg(
1364 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1365 "VUID-VkImageCreateInfo-flags-00949",
1366 "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 -07001367 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001368
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001369 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001370 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1371 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1372 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001373 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 +00001374 "VUID-VkImageCreateInfo-usage-00964",
1375 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1376 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001377 }
1378
1379 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001380 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 +00001381 "VUID-VkImageCreateInfo-usage-00965",
1382 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1383 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001384 }
1385
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001386 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001387 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001388 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1389 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1390 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1391 string_VkFormat(pCreateInfo->format));
1392 } else {
1393 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1394 const char *format_string = string_VkFormat(pCreateInfo->format);
1395 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1396 "VUID-VkImageCreateInfo-mipLevels-02255",
1397 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1398 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1399 }
Dave Houlton130c0212018-01-29 13:39:56 -07001400
Dave Houltona585d132019-01-18 13:05:42 -07001401 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1402 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1403 (uint64_t)pCreateInfo->samples;
1404 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001405
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001406 // Round up to imageGranularity boundary
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001407 VkDeviceSize imageGranularity = GetPDProperties()->limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001408 uint64_t ig_mask = imageGranularity - 1;
1409 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001410
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001411 if (total_size > format_limits.maxResourceSize) {
1412 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1413 kVUID_Core_Image_InvalidFormatLimitsViolation,
1414 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1415 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1416 total_size, format_limits.maxResourceSize);
1417 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001418
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001419 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1420 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1421 "VUID-VkImageCreateInfo-arrayLayers-02256",
1422 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1423 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1424 }
1425
1426 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1427 skip |=
1428 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1429 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001430 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001431 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001432 }
1433
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001434 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001435 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 -06001436 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001437 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1438 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001439 }
1440
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001441 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001442 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1443 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1444 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1445 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001446 skip |=
1447 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1448 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1449 "format must be block, ETC or ASTC compressed, but is %s",
1450 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001451 }
1452 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1453 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001454 skip |=
1455 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1456 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1457 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001458 }
1459 }
1460 }
1461
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001462 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001463 skip |=
1464 ValidateQueueFamilies(device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1465 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1466 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001467 }
1468
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001469 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001470}
1471
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001472void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1473 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001474 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001475 IMAGE_LAYOUT_NODE image_state;
1476 image_state.layout = pCreateInfo->initialLayout;
1477 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001478 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001479 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001480 RecordCreateImageANDROID(pCreateInfo, is_node);
1481 }
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001482 GetImageMap()->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001483 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001484 (*GetImageSubresourceMap())[*pImage].push_back(subpair);
1485 (*GetImageLayoutMap())[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001486}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001487
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001488bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001489 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001490 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001491 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001492 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001493 if (image_state) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001494 skip |= ValidateObjectNotInUse(device_data, image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001495 }
1496 return skip;
1497}
1498
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001499void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001500 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001501 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001502 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001503 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001504 InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001505 // Clean up memory mapping, bindings and range references for image
1506 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001507 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001508 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001509 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001510 }
1511 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001512 ClearMemoryObjectBindings(obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001513 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001514 // Remove image from imageMap
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001515 GetImageMap()->erase(image);
1516 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap = GetImageSubresourceMap();
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001517
1518 const auto &sub_entry = imageSubresourceMap->find(image);
1519 if (sub_entry != imageSubresourceMap->end()) {
1520 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001521 GetImageLayoutMap()->erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001522 }
1523 imageSubresourceMap->erase(sub_entry);
1524 }
1525}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001526
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001527bool CoreChecks::ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001528 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001529
1530 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1531 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1532 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 -06001533 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001534 }
1535
Dave Houlton1d2022c2017-03-29 11:43:58 -06001536 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001537 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1538 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 -06001539 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001540 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001541 char const str[] = "vkCmdClearColorImage called with compressed image.";
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-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001544 }
1545
1546 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1547 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1548 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 -06001549 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001550 }
1551 return skip;
1552}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001553
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001554uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1555 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1556 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001557 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001558 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001559 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001560 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001561}
1562
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001563uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1564 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1565 uint32_t array_layer_count = range->layerCount;
1566 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1567 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001568 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001569 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001570}
1571
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001572bool CoreChecks::VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
1573 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001574 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001575
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001576 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1577 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001578
1579 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1580 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001581 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1582 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001583 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 -06001584 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001585 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1586 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001587 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001588 if (!GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001589 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001590 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 -06001591 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001592 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1593 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001594
1595 } else {
1596 if (image_state->shared_presentable) {
1597 skip |= log_msg(
1598 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001599 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001600 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1601 string_VkImageLayout(dest_image_layout));
1602 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001603 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001604 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001605 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001606 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001607 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001608 } else {
1609 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1610 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001611 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001612 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001613 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1614 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001615 }
1616 }
1617
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001618 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1619 uint32_t level = level_index + range.baseMipLevel;
1620 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1621 uint32_t layer = layer_index + range.baseArrayLayer;
1622 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001623 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001624 if (FindCmdBufLayout(cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001625 if (node.layout != dest_image_layout) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001626 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001627 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001628 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001629 } else {
1630 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1631 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001632 skip |=
1633 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1634 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1635 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001636 }
1637 }
1638 }
1639 }
1640
1641 return skip;
1642}
1643
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001644void CoreChecks::RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image,
1645 VkImageSubresourceRange range, VkImageLayout dest_image_layout) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001646 VkImageCreateInfo *image_create_info = &(GetImageState(image)->createInfo);
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001647 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1648 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001649
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001650 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1651 uint32_t level = level_index + range.baseMipLevel;
1652 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1653 uint32_t layer = layer_index + range.baseArrayLayer;
1654 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001655 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001656 if (!FindCmdBufLayout(cb_node, image, sub, node)) {
1657 SetLayout(cb_node, image, sub, IMAGE_CMD_BUF_LAYOUT_NODE(dest_image_layout, dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001658 }
1659 }
1660 }
1661}
1662
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001663bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1664 const VkClearColorValue *pColor, uint32_t rangeCount,
1665 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001666 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1667
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001668 bool skip = false;
1669 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001670 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001671 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001672 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001673 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearColorImage()",
1674 "VUID-vkCmdClearColorImage-image-00003");
1675 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001676 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001677 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001678 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001679 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
1680 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993",
1681 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001682 }
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001683 skip |= InsideRenderPass(device_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001684 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001685 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001686 skip |= ValidateCmdClearColorSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
1687 skip |= ValidateImageAttributes(device_data, image_state, pRanges[i]);
1688 skip |= VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001689 }
1690 }
1691 return skip;
1692}
1693
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001694void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1695 const VkClearColorValue *pColor, uint32_t rangeCount,
1696 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001697 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1698
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001699 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001700 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001701 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001702 AddCommandBufferBindingImage(device_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001703 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001704 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001705 }
1706 }
1707}
1708
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001709bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1710 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1711 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001712 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001713 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001714
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001715 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001716 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001717 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001718 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001719 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1720 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001721 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001722 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001723 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001724 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04001725 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001726 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1727 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001728 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001729 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001730 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001731 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001732 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001733 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001734 skip |=
1735 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001736 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001737 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1738 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001739 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001740 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1741 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001742 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 -06001743 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001744 }
1745 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001746 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001747 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001748 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 -06001749 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001750 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001751 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1752 char const str[] =
1753 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1754 "set.";
1755 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 -06001756 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001757 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001758 }
1759 return skip;
1760}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001761
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001762void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1763 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1764 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001765 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1766
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001767 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001768 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001769 if (cb_node && image_state) {
1770 AddCommandBufferBindingImage(device_data, cb_node, image_state);
1771 for (uint32_t i = 0; i < rangeCount; ++i) {
1772 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
1773 }
1774 }
1775}
1776
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001777// Returns true if [x, xoffset] and [y, yoffset] overlap
1778static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1779 bool result = false;
1780 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1781 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1782
1783 if (intersection_max > intersection_min) {
1784 result = true;
1785 }
1786 return result;
1787}
1788
Dave Houltonc991cc92018-03-06 11:08:51 -07001789// Returns true if source area of first copy region intersects dest area of second region
1790// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1791static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001792 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001793
Dave Houltonc991cc92018-03-06 11:08:51 -07001794 // Separate planes within a multiplane image cannot intersect
1795 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001796 return result;
1797 }
1798
Dave Houltonc991cc92018-03-06 11:08:51 -07001799 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1800 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1801 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001802 result = true;
1803 switch (type) {
1804 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001805 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001806 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001807 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001808 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001809 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001810 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001811 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001812 break;
1813 default:
1814 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1815 assert(false);
1816 }
1817 }
1818 return result;
1819}
1820
Dave Houltonfc1a4052017-04-27 14:32:45 -06001821// Returns non-zero if offset and extent exceed image extents
1822static const uint32_t x_bit = 1;
1823static const uint32_t y_bit = 2;
1824static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001825static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001826 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001827 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001828 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1829 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001830 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001831 }
1832 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1833 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001834 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001835 }
1836 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1837 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001838 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001839 }
1840 return result;
1841}
1842
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001843// Test if two VkExtent3D structs are equivalent
1844static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1845 bool result = true;
1846 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1847 (extent->depth != other_extent->depth)) {
1848 result = false;
1849 }
1850 return result;
1851}
1852
Dave Houltonee281a52017-12-08 13:51:02 -07001853// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1854// Destination image texel extents must be adjusted by block size for the dest validation checks
1855VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1856 VkExtent3D adjusted_extent = extent;
1857 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001858 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001859 adjusted_extent.width /= block_size.width;
1860 adjusted_extent.height /= block_size.height;
1861 adjusted_extent.depth /= block_size.depth;
1862 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001863 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001864 adjusted_extent.width *= block_size.width;
1865 adjusted_extent.height *= block_size.height;
1866 adjusted_extent.depth *= block_size.depth;
1867 }
1868 return adjusted_extent;
1869}
1870
Dave Houlton6f9059e2017-05-02 17:15:13 -06001871// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001872static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1873 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001874
1875 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001876 if (mip >= img->createInfo.mipLevels) {
1877 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001878 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001879
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001880 // 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 -06001881 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001882
Dave Houltone48cd112019-01-03 17:01:18 -07001883 // If multi-plane, adjust per-plane extent
1884 if (FormatIsMultiplane(img->createInfo.format)) {
1885 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1886 extent.width /= divisors.width;
1887 extent.height /= divisors.height;
1888 }
1889
Jeff Bolzef40fec2018-09-01 22:04:34 -05001890 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1891 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001892 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001893 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1894 } else {
1895 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1896 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1897 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1898 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001899
Dave Houlton6f9059e2017-05-02 17:15:13 -06001900 // Image arrays have an effective z extent that isn't diminished by mip level
1901 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001902 extent.depth = img->createInfo.arrayLayers;
1903 }
1904
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001905 return extent;
1906}
1907
1908// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001909static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001910 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1911}
1912
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001913// Test if the extent argument has any dimensions set to 0.
1914static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1915 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1916}
1917
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001918// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001919VkExtent3D CoreChecks::GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001920 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1921 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07001922 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001923 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001924 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001925 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001926 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001927 granularity.width *= block_size.width;
1928 granularity.height *= block_size.height;
1929 }
1930 }
1931 return granularity;
1932}
1933
1934// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1935static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1936 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001937 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1938 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001939 valid = false;
1940 }
1941 return valid;
1942}
1943
1944// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001945bool CoreChecks::CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1946 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
1947 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001948 bool skip = false;
1949 VkExtent3D offset_extent = {};
1950 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1951 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1952 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001953 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001954 // 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 -07001955 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001956 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04001957 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001958 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) when the command buffer's queue family "
1959 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001960 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001961 }
1962 } else {
1963 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1964 // integer multiples of the image transfer granularity.
1965 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001966 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 -04001967 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001968 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1969 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001970 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1971 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001972 }
1973 }
1974 return skip;
1975}
1976
1977// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001978bool CoreChecks::CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1979 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1980 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
1981 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001982 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001983 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001984 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1985 // subresource extent.
1986 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001987 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04001988 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001989 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1990 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1991 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1992 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001993 }
1994 } else {
1995 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1996 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1997 // subresource extent dimensions.
1998 VkExtent3D offset_extent_sum = {};
1999 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2000 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2001 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002002 bool x_ok = true;
2003 bool y_ok = true;
2004 bool z_ok = true;
2005 switch (image_type) {
2006 case VK_IMAGE_TYPE_3D:
2007 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2008 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002009 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002010 case VK_IMAGE_TYPE_2D:
2011 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2012 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002013 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002014 case VK_IMAGE_TYPE_1D:
2015 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2016 (subresource_extent->width == offset_extent_sum.width));
2017 break;
2018 default:
2019 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2020 assert(false);
2021 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002022 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002023 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 -04002024 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002025 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2026 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2027 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2028 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2029 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2030 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002031 }
2032 }
2033 return skip;
2034}
2035
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002036bool CoreChecks::ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2037 uint32_t mip_level, const uint32_t i, const char *function, const char *member,
2038 const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002039 bool skip = false;
2040 if (mip_level >= img->createInfo.mipLevels) {
2041 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2042 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07002043 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
2044 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002045 }
2046 return skip;
2047}
2048
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002049bool CoreChecks::ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2050 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i,
2051 const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002052 bool skip = false;
2053 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2054 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2055 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2056 HandleToUint64(cb_node->commandBuffer), vuid,
2057 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07002058 "%u, but provided image %s has %u array layers.",
2059 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2060 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002061 }
2062 return skip;
2063}
2064
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002065// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002066bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2067 const IMAGE_STATE *img, const VkBufferImageCopy *region,
2068 const uint32_t i, const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002069 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002070 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2071 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2072 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2073 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2074 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002075 return skip;
2076}
2077
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002078// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002079bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2080 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2081 const VkImageCopy *region, const uint32_t i,
2082 const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002083 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002084 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002085 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002086 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2087 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002088 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002089 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002090 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002091 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002092
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002093 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002094 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002095 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2096 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002097 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002098 const VkExtent3D dest_effective_extent =
2099 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002100 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002101 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002102 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002103 return skip;
2104}
2105
Dave Houlton6f9059e2017-05-02 17:15:13 -06002106// Validate contents of a VkImageCopy struct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002107bool CoreChecks::ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data,
2108 const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
2109 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002110 bool skip = false;
2111
2112 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002113 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002114
2115 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002116 const VkExtent3D src_copy_extent = region.extent;
2117 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002118 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2119
Dave Houlton6f9059e2017-05-02 17:15:13 -06002120 bool slice_override = false;
2121 uint32_t depth_slices = 0;
2122
2123 // Special case for copying between a 1D/2D array and a 3D image
2124 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2125 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002126 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002127 slice_override = (depth_slices != 1);
2128 } 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 -07002129 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002130 slice_override = (depth_slices != 1);
2131 }
2132
2133 // Do all checks on source image
2134 //
2135 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002136 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2137 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 -06002138 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002139 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002140 "be 0 and 1, respectively.",
2141 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002142 }
2143 }
2144
Dave Houlton533be9f2018-03-26 17:08:30 -06002145 // VUID-VkImageCopy-srcImage-01785
2146 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2147 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 -06002148 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002149 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002150 "these must be 0 and 1, respectively.",
2151 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002152 }
2153
Dave Houlton533be9f2018-03-26 17:08:30 -06002154 // VUID-VkImageCopy-srcImage-01787
2155 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2156 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 -06002157 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002158 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2159 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002160 }
2161
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002162 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002163 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002164 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002165 skip |=
2166 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002167 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002168 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002169 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2170 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002171 }
2172 }
2173 } else { // Pre maint 1
2174 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002175 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002176 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 -06002177 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002178 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2179 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002180 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2181 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002182 }
2183 }
2184 }
2185
Dave Houltonc991cc92018-03-06 11:08:51 -07002186 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002187 bool ext_ycbcr = GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002188 if (FormatIsCompressed(src_state->createInfo.format) ||
2189 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002190 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002191 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002192 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2193 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2194 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002195 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002196 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 -07002197 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002198 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002199 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002200 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002201 }
2202
Dave Houlton94a00372017-12-14 15:08:47 -07002203 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002204 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2205 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002206 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002207 skip |=
2208 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002209 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002210 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002211 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002212 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002213 }
2214
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002215 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002216 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2217 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002218 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002219 skip |=
2220 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002221 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002222 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002223 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002224 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002225 }
2226
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002227 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002228 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2229 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002230 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002231 skip |=
2232 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002233 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002234 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002235 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002236 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002237 }
2238 } // Compressed
2239
2240 // Do all checks on dest image
2241 //
2242 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002243 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002244 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 -06002245 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002246 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002247 "these must be 0 and 1, respectively.",
2248 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002249 }
2250 }
2251
Dave Houlton533be9f2018-03-26 17:08:30 -06002252 // VUID-VkImageCopy-dstImage-01786
2253 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2254 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 -06002255 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002256 "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 -06002257 "and 1, respectively.",
2258 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002259 }
2260
2261 // VUID-VkImageCopy-dstImage-01788
2262 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2263 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 -06002264 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002265 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2266 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 }
2268
2269 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002270 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002271 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 -06002272 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002273 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002274 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2275 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002276 }
2277 }
2278 // VU01199 changed with mnt1
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002279 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002280 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002281 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002282 skip |=
2283 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002284 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002285 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002286 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2287 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002288 }
2289 }
2290 } else { // Pre maint 1
2291 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002292 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002293 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 -06002294 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002295 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2296 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002297 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2298 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002299 }
2300 }
2301 }
2302
Dave Houltonc991cc92018-03-06 11:08:51 -07002303 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2304 if (FormatIsCompressed(dst_state->createInfo.format) ||
2305 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002306 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002307
2308 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002309 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2310 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2311 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002312 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002313 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 -07002314 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002315 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002316 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002317 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002318 }
2319
Dave Houlton94a00372017-12-14 15:08:47 -07002320 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002321 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2322 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002323 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002324 skip |=
2325 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002326 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002327 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002328 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002329 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002330 }
2331
Dave Houltonee281a52017-12-08 13:51:02 -07002332 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2333 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2334 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002335 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002336 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 -07002337 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002338 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2339 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002340 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002341 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002342 }
2343
Dave Houltonee281a52017-12-08 13:51:02 -07002344 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2345 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2346 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002347 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002348 skip |=
2349 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002350 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002351 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002352 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002353 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002354 }
2355 } // Compressed
2356 }
2357 return skip;
2358}
2359
Dave Houltonc991cc92018-03-06 11:08:51 -07002360// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002361bool CoreChecks::CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer,
2362 const IMAGE_STATE *src_image_state, const IMAGE_STATE *dst_image_state,
2363 const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002364 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002365
2366 // Neither image is multiplane
2367 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2368 // If neither image is multi-plane the aspectMask member of src and dst must match
2369 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2370 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002371 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002372 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2373 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 -06002374 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002375 }
2376 } else {
2377 // Source image multiplane checks
2378 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2379 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2380 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2381 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002382 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002383 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002384 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002385 }
2386 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2387 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2388 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002389 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002390 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 -06002391 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002392 }
2393 // Single-plane to multi-plane
2394 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2395 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2396 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002397 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002398 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 -06002399 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002400 }
2401
2402 // Dest image multiplane checks
2403 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2404 aspect = region.dstSubresource.aspectMask;
2405 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2406 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002407 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002408 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002409 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002410 }
2411 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2412 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2413 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002414 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002415 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 -06002416 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002417 }
2418 // Multi-plane to single-plane
2419 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2420 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2421 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002422 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002423 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002424 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002425 }
2426 }
2427
2428 return skip;
2429}
2430
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002431bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2432 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2433 const VkImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002434 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002435 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002436 auto src_image_state = GetImageState(srcImage);
2437 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002438 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002439
2440 skip = ValidateImageCopyData(device_data, report_data, regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002441
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002442 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2443
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002444 for (uint32_t i = 0; i < regionCount; i++) {
2445 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002446
2447 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2448 VkExtent3D src_copy_extent = region.extent;
2449 VkExtent3D dst_copy_extent =
2450 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2451
Dave Houlton6f9059e2017-05-02 17:15:13 -06002452 bool slice_override = false;
2453 uint32_t depth_slices = 0;
2454
2455 // Special case for copying between a 1D/2D array and a 3D image
2456 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2457 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2458 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002459 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002460 slice_override = (depth_slices != 1);
2461 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2462 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002463 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002464 slice_override = (depth_slices != 1);
2465 }
2466
Cort Strattond619a302018-05-17 19:46:32 -07002467 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2468 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002469 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2470 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2471 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2472 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2473 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2474 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2475 "VUID-vkCmdCopyImage-srcSubresource-01698");
2476 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2477 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2478 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002479
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002480 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002481 // No chance of mismatch if we're overriding depth slice count
2482 if (!slice_override) {
2483 // The number of depth slices in srcSubresource and dstSubresource must match
2484 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2485 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002486 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2487 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002488 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002489 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2490 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002491 if (src_slices != dst_slices) {
2492 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002493 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002494 << "] do not match";
2495 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 -06002496 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002497 }
2498 }
2499 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002500 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002501 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002502 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002503 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002504 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002505 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 -06002506 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002507 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002508 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002509
Dave Houltonc991cc92018-03-06 11:08:51 -07002510 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002511 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002512 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2513 }
2514
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002515 if (!GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002516 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2517 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002518 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002519 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 -06002520 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002521 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002522 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002523
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002524 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002525 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002526 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002527 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002528 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2529 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-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002531 }
2532
2533 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002534 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002535 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002536 ss << "vkCmdCopyImage(): pRegion[" << i
2537 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002538 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 -06002539 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002540 }
2541
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002542 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2543 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2544 // 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 -07002545 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2546 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002547 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002548 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002549 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2550 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2551 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002552 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 -06002553 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002554 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002555
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002556 // 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 -07002557 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2558 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002559 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002560 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002561 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2562 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2563 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002564 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 -06002565 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002566 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002567 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002568
Dave Houltonfc1a4052017-04-27 14:32:45 -06002569 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002570 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2571 if (slice_override) src_copy_extent.depth = depth_slices;
2572 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002573 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002574 skip |=
2575 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2576 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2577 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2578 "width [%1d].",
2579 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002580 }
2581
2582 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002583 skip |=
2584 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2585 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2586 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2587 "height [%1d].",
2588 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002589 }
2590 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002591 skip |=
2592 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2593 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2594 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2595 "depth [%1d].",
2596 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002597 }
2598
Dave Houltonee281a52017-12-08 13:51:02 -07002599 // Adjust dest extent if necessary
2600 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2601 if (slice_override) dst_copy_extent.depth = depth_slices;
2602
2603 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002604 if (extent_check & x_bit) {
2605 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 -06002606 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002607 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002608 "width [%1d].",
2609 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002610 }
2611 if (extent_check & y_bit) {
2612 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 -06002613 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002614 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002615 "height [%1d].",
2616 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002617 }
2618 if (extent_check & z_bit) {
2619 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002620 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002621 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002622 "depth [%1d].",
2623 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002624 }
2625
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2627 // must not overlap in memory
2628 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002629 for (uint32_t j = 0; j < regionCount; j++) {
2630 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002631 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002632 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002633 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002634 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 -06002635 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002636 }
2637 }
2638 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002639 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002640
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002641 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2642 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2643 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002644 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002645 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2646 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002647 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 -06002648 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002649 }
2650 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002651 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002652 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2653 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 -06002654 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002655 }
2656 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002657
Dave Houlton33c22b72017-02-28 13:16:02 -07002658 // Source and dest image sample counts must match
2659 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2660 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2661 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 -06002662 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002663 }
2664
Dave Houltond8ed0212018-05-16 17:18:24 -06002665 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2666 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002667 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002668 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2669 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2670 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2671 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07002672 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002673 skip |=
2674 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002675 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002676 skip |=
2677 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002678 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002679 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002680 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002681 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2682 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002683 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002684 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002685 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002686 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002687 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002688 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2689 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002690 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002691 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002692 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2693 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002694 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002695 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002696 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2697 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002698 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002699 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2700 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002701 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002702 &pRegions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002703 }
2704
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002705 return skip;
2706}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002707
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002708void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2709 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2710 const VkImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002711 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002712 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002713 auto src_image_state = GetImageState(srcImage);
2714 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002715
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002716 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002717 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002718 SetImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2719 SetImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002720 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002721 // Update bindings between images and cmd buffer
2722 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2723 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002724}
2725
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002726// Returns true if sub_rect is entirely contained within rect
2727static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2728 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2729 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2730 return false;
2731 return true;
2732}
2733
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002734bool CoreChecks::ValidateClearAttachmentExtent(layer_data *device_data, VkCommandBuffer command_buffer, uint32_t attachment_index,
2735 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2736 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002737 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002738 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2739 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002740 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002741 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002742
2743 for (uint32_t j = 0; j < rect_count; j++) {
2744 if (!ContainsRect(render_area, clear_rects[j].rect)) {
2745 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2746 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2747 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2748 "the current render pass instance.",
2749 j);
2750 }
2751
2752 if (image_view_state) {
2753 // The layers specified by a given element of pRects must be contained within every attachment that
2754 // pAttachments refers to
2755 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2756 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2757 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
2758 skip |=
2759 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2760 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2761 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2762 "of pAttachment[%d].",
2763 j, attachment_index);
2764 }
2765 }
2766 }
2767 return skip;
2768}
2769
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002770bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2771 const VkClearAttachment *pAttachments, uint32_t rectCount,
2772 const VkClearRect *pRects) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002773 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2774
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002775 GLOBAL_CB_NODE *cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002776
2777 bool skip = false;
2778 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002779 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002780 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002781 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002782 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002783 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002784 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2785 // 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 -07002786 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2787 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002788 skip |=
2789 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2790 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2791 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2792 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2793 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002794 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002795 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002796 }
2797
2798 // Validate that attachment is in reference list of active subpass
2799 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002800 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002801 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002802 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002803 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002804 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2805 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002806
John Zulauf3a548ef2019-02-01 16:14:07 -07002807 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2808 auto clear_desc = &pAttachments[attachment_index];
2809 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002810
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002811 if (0 == clear_desc->aspectMask) {
2812 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 -06002813 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002814 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2815 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 -06002816 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002817 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002818 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2819 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2820 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2821 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002822 skip |= log_msg(
2823 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2824 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2825 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2826 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2827 attachment_index, clear_desc->colorAttachment,
2828 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2829 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2830
John Zulauff2582972019-02-09 14:53:30 -07002831 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2832 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002833 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002834 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2835 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2836 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2837 " subpass %u. colorAttachmentCount=%u",
2838 attachment_index, clear_desc->colorAttachment,
2839 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2840 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002841 }
John Zulauff2582972019-02-09 14:53:30 -07002842 fb_attachment = color_attachment;
2843
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002844 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2845 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2846 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002847 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002848 skip |=
2849 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2850 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002851 }
2852 } else { // Must be depth and/or stencil
2853 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2854 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002855 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002856 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 -07002857 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2858 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002859 }
2860 if (!subpass_desc->pDepthStencilAttachment ||
2861 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2862 skip |= log_msg(
2863 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002864 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002865 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002866 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002867 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002868 }
2869 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002870 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002871 skip |= ValidateClearAttachmentExtent(device_data, commandBuffer, attachment_index, framebuffer, fb_attachment,
2872 render_area, rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002873 } else {
2874 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2875 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2876 if (!clear_rect_copy) {
2877 // We need a copy of the clear rectangles that will persist until the last lambda executes
2878 // but we want to create it as lazily as possible
2879 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002880 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002881
2882 auto val_fn = [device_data, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
2883 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2884 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002885 FRAMEBUFFER_STATE *framebuffer = device_data->GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002886 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2887 bool skip = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002888 skip =
2889 device_data->ValidateClearAttachmentExtent(device_data, commandBuffer, attachment_index, framebuffer,
2890 fb_attachment, render_area, rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002891 return skip;
2892 };
2893 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002894 }
2895 }
2896 }
2897 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002898}
2899
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002900bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2901 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2902 const VkImageResolve *pRegions) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002903 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002904 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002905 auto src_image_state = GetImageState(srcImage);
2906 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002907
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002908 bool skip = false;
2909 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002910 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2911 "VUID-vkCmdResolveImage-srcImage-00256");
2912 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2913 "VUID-vkCmdResolveImage-dstImage-00258");
2914 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2915 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002916 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002917 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002918 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002919 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2920 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002921
Cort Stratton7df30962018-05-17 19:45:57 -07002922 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002923 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002924 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002925 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2926 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2927 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002928 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002929 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2930 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002931 // For each region, the number of layers in the image subresource should not be zero
2932 // For each region, src and dest image aspect must be color only
2933 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002934 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2935 "srcSubresource", i);
2936 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2937 "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002938 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002939 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2940 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002941 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002942 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2943 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002944 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2945 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2946 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2947 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2948 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2949 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2950 "VUID-vkCmdResolveImage-srcSubresource-01711");
2951 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2952 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2953 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002954
2955 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002956 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2957 skip |= log_msg(
2958 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002959 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002960 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002961 }
Cort Stratton7df30962018-05-17 19:45:57 -07002962 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002963 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2964 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2965 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002966 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002967 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 -06002968 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002969 }
2970 }
2971
2972 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2973 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002974 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 -06002975 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002976 }
2977 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2978 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002979 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 -06002980 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002981 }
2982 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2983 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2984 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 -06002985 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002986 }
2987 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2988 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2989 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 -06002990 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002991 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002992 } else {
2993 assert(0);
2994 }
2995 return skip;
2996}
2997
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002998void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2999 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3000 const VkImageResolve *pRegions) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003001 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003002 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003003 auto src_image_state = GetImageState(srcImage);
3004 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003005
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003006 // Update bindings between images and cmd buffer
3007 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3008 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003009}
3010
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003011bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3012 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3013 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003014 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003015 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003016 auto src_image_state = GetImageState(srcImage);
3017 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003018
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003019 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003020 if (cb_node) {
3021 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3022 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003023 if (cb_node && src_image_state && dst_image_state) {
3024 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003025 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003026 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003027 "VUID-vkCmdBlitImage-dstImage-00234");
3028 skip |=
3029 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3030 skip |=
3031 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
3032 skip |=
3033 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
3034 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3035 skip |=
3036 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
3037 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3038 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
3039 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003040 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003041 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04003042 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003043 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04003044 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003045 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003046
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003047 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003048
Dave Houlton33c2d252017-06-09 17:08:32 -06003049 VkFormat src_format = src_image_state->createInfo.format;
3050 VkFormat dst_format = dst_image_state->createInfo.format;
3051 VkImageType src_type = src_image_state->createInfo.imageType;
3052 VkImageType dst_type = dst_image_state->createInfo.imageType;
3053
Cort Stratton186b1a22018-05-01 20:18:06 -04003054 if (VK_FILTER_LINEAR == filter) {
3055 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003056 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3057 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003058 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003059 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
3060 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003061 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003062 }
3063
3064 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3065 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 -06003066 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003067 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003068 }
3069
Dave Houlton33c2d252017-06-09 17:08:32 -06003070 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3071 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3072 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 -06003073 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003074 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003075 }
3076
3077 // Validate consistency for unsigned formats
3078 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3079 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003080 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003081 << "the other one must also have unsigned integer format. "
3082 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3083 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 -06003084 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003085 }
3086
3087 // Validate consistency for signed formats
3088 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3089 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003090 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003091 << "the other one must also have signed integer format. "
3092 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3093 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003094 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003095 }
3096
3097 // Validate filter for Depth/Stencil formats
3098 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3099 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003100 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003101 << "then filter must be VK_FILTER_NEAREST.";
3102 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 -06003103 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003104 }
3105
3106 // Validate aspect bits and formats for depth/stencil images
3107 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3108 if (src_format != dst_format) {
3109 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003110 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003111 << "stencil, the other one must have exactly the same format. "
3112 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3113 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003114 skip |=
3115 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3116 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003117 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003118 } // Depth or Stencil
3119
3120 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003121 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003122 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003123 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3124 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3125 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003126 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003127 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3128 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003129 for (uint32_t i = 0; i < regionCount; i++) {
3130 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003131 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003132 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003133 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3134 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003135 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003136 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3137 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003138 skip |=
3139 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3140 skip |=
3141 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003142 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3143 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3144 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3145 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3146 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3147 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3148 "VUID-vkCmdBlitImage-srcSubresource-01707");
3149 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3150 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3151 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003152 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003153 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3154 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003155 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003156 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003157 skip |=
3158 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3159 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003160 }
Dave Houlton48989f32017-05-26 15:01:46 -06003161 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3162 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003163 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003164 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003165 skip |=
3166 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3167 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003168 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003169
3170 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003171 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003172 skip |= log_msg(
3173 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3174 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3175 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003176 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003177
Dave Houlton48989f32017-05-26 15:01:46 -06003178 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003179 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003180 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003181 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003182 }
Dave Houlton48989f32017-05-26 15:01:46 -06003183
Dave Houlton33c2d252017-06-09 17:08:32 -06003184 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3185 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 -06003186 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003187 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003188 "image format %s.",
3189 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003190 }
3191
3192 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3193 skip |= log_msg(
3194 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003195 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003196 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3197 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003198 }
3199
Dave Houlton48989f32017-05-26 15:01:46 -06003200 // Validate source image offsets
3201 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003202 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003203 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003204 skip |=
3205 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3206 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3207 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3208 "of (%1d, %1d). These must be (0, 1).",
3209 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003210 }
3211 }
3212
Dave Houlton33c2d252017-06-09 17:08:32 -06003213 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003214 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3215 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 -06003216 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003217 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003218 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3219 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003220 }
3221 }
3222
Dave Houlton33c2d252017-06-09 17:08:32 -06003223 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003224 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3225 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003226 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003227 skip |= log_msg(
3228 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3229 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3230 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3231 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003232 }
3233 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3234 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003235 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003236 skip |= log_msg(
3237 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003238 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003239 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003240 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003241 }
3242 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3243 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003244 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003245 skip |= log_msg(
3246 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3247 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3248 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3249 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003250 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003251 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003252 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003253 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003254 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003255 }
Dave Houlton48989f32017-05-26 15:01:46 -06003256
3257 // Validate dest image offsets
3258 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003259 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003260 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003261 skip |=
3262 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3263 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3264 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3265 "(%1d, %1d). These must be (0, 1).",
3266 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003267 }
3268 }
3269
Dave Houlton33c2d252017-06-09 17:08:32 -06003270 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003271 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3272 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 -06003273 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003274 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003275 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3276 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003277 }
3278 }
3279
Dave Houlton33c2d252017-06-09 17:08:32 -06003280 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003281 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3282 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003283 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003284 skip |= log_msg(
3285 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3286 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3287 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3288 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003289 }
3290 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3291 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003292 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003293 skip |= log_msg(
3294 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003295 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003296 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003297 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003298 }
3299 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3300 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003301 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003302 skip |= log_msg(
3303 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3304 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3305 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3306 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003307 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003308 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003309 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 -06003310 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003311 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003312 }
3313
Dave Houlton33c2d252017-06-09 17:08:32 -06003314 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3315 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3316 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003317 skip |=
3318 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3319 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3320 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3321 "layerCount other than 1.",
3322 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003323 }
3324 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003325 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003326 } else {
3327 assert(0);
3328 }
3329 return skip;
3330}
3331
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003332void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3333 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3334 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003335 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003336 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003337 auto src_image_state = GetImageState(srcImage);
3338 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003339
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003340 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003341 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003342 SetImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3343 SetImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003344 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003345 // Update bindings between images and cmd buffer
3346 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3347 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003348}
3349
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003350// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003351bool CoreChecks::ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
3352 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3353 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003354 bool skip = false;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003355 for (auto cb_image_data : pCB->imageLayoutMap) {
3356 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003357
Dave Houltonb3f4b282018-02-22 16:25:16 -07003358 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3359 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003360 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3361 // TODO: Set memory invalid which is in mem_tracker currently
3362 } else if (imageLayout != cb_image_data.second.initialLayout) {
3363 if (cb_image_data.first.hasSubresource) {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003364 skip |=
3365 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3366 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07003367 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, mip level "
3368 "%u) to be in layout %s--instead, image %s's current layout is %s.",
3369 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3370 cb_image_data.first.subresource.aspectMask, cb_image_data.first.subresource.arrayLayer,
3371 cb_image_data.first.subresource.mipLevel, string_VkImageLayout(cb_image_data.second.initialLayout),
3372 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
3373 } else {
3374 skip |= log_msg(
3375 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3376 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3377 "Submitted command buffer expects image %s to be in layout %s--instead, image %s's current layout is %s.",
3378 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3379 string_VkImageLayout(cb_image_data.second.initialLayout),
3380 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003381 }
3382 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003383 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003384 }
3385 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003386 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003387}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003388
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003389void CoreChecks::UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
Tony Barbourdf013b92017-01-25 12:53:48 -07003390 for (auto cb_image_data : pCB->imageLayoutMap) {
3391 VkImageLayout imageLayout;
3392 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003393 SetGlobalLayout(cb_image_data.first, cb_image_data.second.layout);
Tony Barbourdf013b92017-01-25 12:53:48 -07003394 }
3395}
3396
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003397// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003398// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3399// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003400bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3401 const VkImageLayout first_layout, const uint32_t attachment,
3402 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003403 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003404 const char *vuid;
3405 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3406
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003407 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3408 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003409 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3410 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3411 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003412 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003413 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3414 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3415 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3416 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3417 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3418 skip |=
3419 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3420 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003421 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003422 }
3423 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003424 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3425 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003426 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003427 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003428 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 -06003429 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003430 }
3431 }
3432
3433 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3434 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003435 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003436 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003437 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 -06003438 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003439 }
3440 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003441 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003442}
3443
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003444bool CoreChecks::ValidateLayouts(layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3445 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003446 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003447 const char *vuid;
3448 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3449 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003450
Jason Ekstranda1906302017-12-03 20:16:32 -08003451 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3452 VkFormat format = pCreateInfo->pAttachments[i].format;
3453 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3454 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3455 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003456 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 -06003457 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003458 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3459 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3460 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3461 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003462 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003463 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003464 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 -06003465 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003466 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3467 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3468 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3469 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003470 }
3471 }
3472 }
3473
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003474 // Track when we're observing the first use of an attachment
3475 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3476 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003477 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003478
3479 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3480 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3481 auto attach_index = subpass.pInputAttachments[j].attachment;
3482 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003483 switch (subpass.pInputAttachments[j].layout) {
3484 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3485 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3486 // These are ideal.
3487 break;
3488
3489 case VK_IMAGE_LAYOUT_GENERAL:
3490 // May not be optimal. TODO: reconsider this warning based on other constraints.
3491 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003492 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003493 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3494 break;
3495
Tobias Hectorbbb12282018-10-22 15:17:59 +01003496 case VK_IMAGE_LAYOUT_UNDEFINED:
3497 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3498 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3499 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3500 "Layout for input attachment reference %u in subpass %u is %s but must be "
3501 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3502 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3503 break;
3504
Graeme Leese668a9862018-10-08 10:40:02 +01003505 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3506 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003507 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003508 break;
3509 } else {
3510 // Intentionally fall through to generic error message
3511 }
3512 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003513
Cort Stratton7547f772017-05-04 15:18:52 -07003514 default:
3515 // No other layouts are acceptable
3516 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 -06003517 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003518 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3519 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3520 }
3521
Cort Stratton7547f772017-05-04 15:18:52 -07003522 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003523 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3524 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003525
3526 bool used_as_depth =
3527 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3528 bool used_as_color = false;
3529 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3530 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3531 }
3532 if (!used_as_depth && !used_as_color &&
3533 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003534 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3535 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3536 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3537 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003538 }
3539 }
3540 attach_first_use[attach_index] = false;
3541 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003542
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003543 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3544 auto attach_index = subpass.pColorAttachments[j].attachment;
3545 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3546
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003547 // TODO: Need a way to validate shared presentable images here, currently just allowing
3548 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3549 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003550 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003551 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003552 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003553 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3554 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003555 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003556
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003557 case VK_IMAGE_LAYOUT_GENERAL:
3558 // May not be optimal; TODO: reconsider this warning based on other constraints?
3559 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003560 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003561 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3562 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003563
Tobias Hectorbbb12282018-10-22 15:17:59 +01003564 case VK_IMAGE_LAYOUT_UNDEFINED:
3565 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3566 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3567 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3568 "Layout for color attachment reference %u in subpass %u is %s but should be "
3569 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3570 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3571 break;
3572
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003573 default:
3574 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 -06003575 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003576 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3577 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003578 }
3579
John Zulauf4eee2692019-02-09 16:14:25 -07003580 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3581 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3582 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003583 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3584 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 -07003585 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003586 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003587 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003588 }
3589
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003590 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003591 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3592 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003593 }
3594 attach_first_use[attach_index] = false;
3595 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003596
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003597 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3598 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003599 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3600 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3601 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003602 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003603
Dave Houltona9df0ce2018-02-07 10:51:23 -07003604 case VK_IMAGE_LAYOUT_GENERAL:
3605 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3606 // doing a bunch of transitions.
3607 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003608 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003609 "GENERAL layout for depth attachment may not give optimal performance.");
3610 break;
3611
Tobias Hectorbbb12282018-10-22 15:17:59 +01003612 case VK_IMAGE_LAYOUT_UNDEFINED:
3613 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3614 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3615 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3616 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3617 "layout or GENERAL.",
3618 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3619 break;
3620
Dave Houltona9df0ce2018-02-07 10:51:23 -07003621 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3622 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003623 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003624 break;
3625 } else {
3626 // Intentionally fall through to generic error message
3627 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003628 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003629
Dave Houltona9df0ce2018-02-07 10:51:23 -07003630 default:
3631 // No other layouts are acceptable
3632 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 -06003633 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003634 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3635 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3636 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003637 }
3638
3639 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3640 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003641 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3642 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003643 }
3644 attach_first_use[attach_index] = false;
3645 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003646 }
3647 return skip;
3648}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003649
3650// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003651bool CoreChecks::ValidateMapImageLayouts(layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3652 VkDeviceSize offset, VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003653 bool skip = false;
3654 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3655 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003656 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3657 for (auto image_handle : mem_info->bound_images) {
3658 auto img_it = mem_info->bound_ranges.find(image_handle);
3659 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003660 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003661 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003662 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003663 for (auto layout : layouts) {
3664 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003665 skip |=
3666 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 -06003667 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003668 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3669 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003670 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003671 }
3672 }
3673 }
3674 }
3675 }
3676 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003677 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003678}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003679
3680// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3681// is true, verify that (actual & desired) flags == desired
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003682bool CoreChecks::ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict,
3683 uint64_t obj_handle, VulkanObjectType obj_type, const char *msgCode, char const *func_name,
3684 char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003685 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003686 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003687 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003688 if (strict) {
3689 correct_usage = ((actual & desired) == desired);
3690 } else {
3691 correct_usage = ((actual & desired) != 0);
3692 }
3693 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003694 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003695 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003696 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3697 kVUID_Core_MemTrack_InvalidUsageFlag,
3698 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3699 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003700 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003701 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3702 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3703 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003704 }
3705 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003706 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003707}
3708
3709// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3710// where an error will be flagged if usage is not correct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003711bool CoreChecks::ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
3712 const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003713 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3714 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003715}
3716
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003717bool CoreChecks::ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
3718 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003719 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003720 bool skip = false;
3721 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3722 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003723 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3724 HandleToUint64(image_state->image), linear_vuid,
3725 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3726 format_properties.linearTilingFeatures, image_state->createInfo.format,
3727 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003728 }
3729 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3730 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3731 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3732 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003733 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003734 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003735 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003736 }
3737 }
3738 return skip;
3739}
3740
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003741bool CoreChecks::ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3742 const VkImageSubresourceLayers *subresource_layers, char const *func_name,
3743 char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003744 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003745 // layerCount must not be zero
3746 if (subresource_layers->layerCount == 0) {
3747 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3748 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3749 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3750 }
3751 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3752 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3753 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3754 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3755 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3756 }
3757 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3758 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3759 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3760 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3761 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3762 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3763 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3764 func_name, i, member);
3765 }
3766 return skip;
3767}
3768
Mark Lobodzinski96210742017-02-09 10:33:46 -07003769// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3770// where an error will be flagged if usage is not correct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003771bool CoreChecks::ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired,
3772 bool strict, const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003773 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3774 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003775}
3776
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003777bool CoreChecks::ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3778 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003779 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003780
3781 const VkDeviceSize &range = pCreateInfo->range;
3782 if (range != VK_WHOLE_SIZE) {
3783 // Range must be greater than 0
3784 if (range <= 0) {
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-range-00928",
3787 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3788 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3789 range);
3790 }
3791 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003792 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003793 if (range % format_size != 0) {
3794 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3795 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3796 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3797 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3798 "(" PRINTF_SIZE_T_SPECIFIER ").",
3799 range, format_size);
3800 }
3801 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3802 if (range / format_size > device_limits->maxTexelBufferElements) {
3803 skip |=
3804 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3805 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3806 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3807 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3808 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3809 range, format_size, device_limits->maxTexelBufferElements);
3810 }
3811 // The sum of range and offset must be less than or equal to the size of buffer
3812 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3813 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3814 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3815 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3816 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3817 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3818 range, pCreateInfo->offset, buffer_state->createInfo.size);
3819 }
3820 }
3821 return skip;
3822}
3823
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003824bool CoreChecks::ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3825 const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003826 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003827 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003828 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3829 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3830 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3831 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3832 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3833 "be supported for uniform texel buffers");
3834 }
3835 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3836 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3837 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3838 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3839 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3840 "be supported for storage texel buffers");
3841 }
3842 return skip;
3843}
3844
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003845bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3846 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003847 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3848
Mark Lobodzinski96210742017-02-09 10:33:46 -07003849 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003850
Dave Houltond8ed0212018-05-16 17:18:24 -06003851 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003852
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003853 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures()->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003854 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 -06003855 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003856 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003857 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003858 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003859
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003860 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures()->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003861 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 -06003862 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003863 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003864 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003865 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003866
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003867 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003868 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 -06003869 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003870 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003871 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003872 }
Jeff Bolz87697532019-01-11 22:54:00 -06003873
3874 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3875 if (chained_devaddr_struct) {
3876 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3877 chained_devaddr_struct->deviceAddress != 0) {
3878 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3879 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3880 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3881 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3882 }
3883 }
3884
3885 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003886 !GetEnabledFeatures()->buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003887 skip |= log_msg(
3888 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3889 "VUID-VkBufferCreateInfo-flags-02605",
3890 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3891 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3892 }
3893
3894 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003895 !GetEnabledFeatures()->buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003896 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3897 "VUID-VkBufferCreateInfo-usage-02606",
3898 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3899 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3900 }
3901
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003902 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003903 skip |=
3904 ValidateQueueFamilies(device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
3905 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3906 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003907 }
3908
Mark Lobodzinski96210742017-02-09 10:33:46 -07003909 return skip;
3910}
3911
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003912void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3913 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003914 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003915 // 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 -07003916 GetBufferMap()->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003917}
3918
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003919bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3920 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003921 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3922
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003923 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003924 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003925 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3926 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003927 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3928 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003929 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3930 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003931 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3932 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3933 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3934 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003935
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003936 // Buffer view offset must be less than the size of buffer
3937 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3938 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3939 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3940 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3941 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3942 pCreateInfo->offset, buffer_state->createInfo.size);
3943 }
3944
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003945 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06003946 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3947 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3948 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3949 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3950 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3951 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3952 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3953 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003954
3955 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003956
3957 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003958 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003959 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003960}
3961
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003962void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3963 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003964 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07003965 (*GetBufferViewMap())[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003966}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003967
3968// For the given format verify that the aspect masks make sense
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003969bool CoreChecks::ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format,
3970 VkImageAspectFlags aspect_mask, const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003971 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003972 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3973 if (image != VK_NULL_HANDLE) {
3974 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3975 }
3976
Dave Houlton1d2022c2017-03-29 11:43:58 -06003977 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003978 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003979 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003980 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003981 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003982 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003983 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003984 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003985 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003986 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003987 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003988 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003989 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3990 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003991 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003992 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003993 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003994 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3995 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003996 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003997 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003998 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003999 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004000 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004001 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004002 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004003 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004004 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004005 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004006 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004007 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004008 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004009 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004010 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004011 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004012 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004013 } else if (FormatIsMultiplane(format)) {
4014 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4015 if (3 == FormatPlaneCount(format)) {
4016 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4017 }
4018 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004019 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004020 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4021 "set, where n = [0, 1, 2].",
4022 func_name);
4023 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004024 }
4025 return skip;
4026}
4027
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004028bool CoreChecks::ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count,
4029 const uint32_t image_layer_count, const VkImageSubresourceRange &subresourceRange,
4030 const char *cmd_name, const char *param_name, const char *image_layer_count_var_name,
4031 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004032 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004033
4034 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004035 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004036 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 -06004037 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004038 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004039 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4040 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004041 }
Petr Kraus4d718682017-05-18 03:38:41 +02004042
Petr Krausffa94af2017-08-08 21:46:02 +02004043 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4044 if (subresourceRange.levelCount == 0) {
4045 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004046 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004047 } else {
4048 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004049
Petr Krausffa94af2017-08-08 21:46:02 +02004050 if (necessary_mip_count > image_mip_count) {
4051 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 -06004052 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004053 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004054 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004055 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004056 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004057 }
Petr Kraus4d718682017-05-18 03:38:41 +02004058 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004059 }
Petr Kraus4d718682017-05-18 03:38:41 +02004060
4061 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004062 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004063 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 -06004064 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004065 "%s: %s.baseArrayLayer (= %" PRIu32
4066 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4067 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004068 }
Petr Kraus4d718682017-05-18 03:38:41 +02004069
Petr Krausffa94af2017-08-08 21:46:02 +02004070 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4071 if (subresourceRange.layerCount == 0) {
4072 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 -06004073 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004074 } else {
4075 const uint64_t necessary_layer_count =
4076 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004077
Petr Krausffa94af2017-08-08 21:46:02 +02004078 if (necessary_layer_count > image_layer_count) {
4079 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 -06004080 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004081 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004082 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004083 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004084 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004085 }
Petr Kraus4d718682017-05-18 03:38:41 +02004086 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004087 }
Petr Kraus4d718682017-05-18 03:38:41 +02004088
Mark Lobodzinski602de982017-02-09 11:01:33 -07004089 return skip;
4090}
4091
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004092bool CoreChecks::ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4093 bool is_imageview_2d_type,
4094 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004095 bool is_khr_maintenance1 = GetDeviceExtensions()->vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004096 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4097 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4098 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4099
4100 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4101 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4102
4103 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004104 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4105 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4106 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4107 : "VUID-VkImageViewCreateInfo-image-01482")
4108 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4109 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4110 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4111 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4112 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004113
4114 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4115 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4116 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4117}
4118
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004119bool CoreChecks::ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4120 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004121 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004122 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4123 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4124 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4125 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004126
4127 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4128 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4129 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4130}
4131
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004132bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4133 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004134 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004135 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4136 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4137 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4138 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004139
4140 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4141 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4142 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4143}
4144
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004145bool CoreChecks::ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4146 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4147 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004148 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004149 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4150 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4151 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4152 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004153
4154 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4155 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4156 subresourceRangeErrorCodes);
4157}
4158
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004159bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4160 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004161 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004162 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004163 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004164 if (image_state) {
4165 skip |= ValidateImageUsageFlags(
4166 device_data, image_state,
4167 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004168 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4169 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004170 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004171 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004172 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004173 skip |=
4174 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004175 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004176 skip |= ValidateCreateImageViewSubresourceRange(
4177 device_data, image_state,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004178 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4179 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004180
4181 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4182 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004183 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4184 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004185 VkFormat view_format = pCreateInfo->format;
4186 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004187 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004188 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004189
Dave Houltonbd2e2622018-04-10 16:41:14 -06004190 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004191 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004192 if (chained_ivuci_struct) {
4193 if (chained_ivuci_struct->usage & ~image_usage) {
4194 std::stringstream ss;
4195 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004196 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004197 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004198 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 -07004199 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004200 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004201 }
4202
4203 image_usage = chained_ivuci_struct->usage;
4204 }
4205
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004206 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4207 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004208 if (FormatIsMultiplane(image_format)) {
4209 // View format must match the multiplane compatible format
4210 uint32_t plane = 3; // invalid
4211 switch (aspect_mask) {
4212 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4213 plane = 0;
4214 break;
4215 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4216 plane = 1;
4217 break;
4218 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4219 plane = 2;
4220 break;
4221 default:
4222 break;
4223 }
4224
4225 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4226 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004227 std::stringstream ss;
4228 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004229 << " is not compatible with plane " << plane << " of underlying image format "
4230 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
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-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004233 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004234 }
4235 } else {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004236 if ((!GetDeviceExtensions()->vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004237 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4238 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4239 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4240 std::stringstream ss;
4241 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004242 << " is not in the same format compatibility class as image ("
4243 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004244 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4245 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004246 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004247 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004248 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004249 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004250 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004251 }
4252 } else {
4253 // Format MUST be IDENTICAL to the format the image was created with
4254 if (image_format != view_format) {
4255 std::stringstream ss;
4256 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004257 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004258 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004259 skip |=
4260 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004261 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004262 }
4263 }
4264
4265 // Validate correct image aspect bits for desired formats and format consistency
4266 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004267
4268 switch (image_type) {
4269 case VK_IMAGE_TYPE_1D:
4270 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004271 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 -07004272 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004273 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4274 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004275 }
4276 break;
4277 case VK_IMAGE_TYPE_2D:
4278 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4279 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4280 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004281 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 -07004282 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004283 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4284 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004285 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004286 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 -07004287 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004288 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4289 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004290 }
4291 }
4292 break;
4293 case VK_IMAGE_TYPE_3D:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004294 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004295 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4296 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4297 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004298 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004299 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004300 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004301 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4302 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004303 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4304 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004305 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004306 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004307 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004308 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4309 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004310 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4311 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004312 }
4313 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004314 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-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004316 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4317 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004318 }
4319 }
4320 } else {
4321 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004322 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 -07004323 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004324 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4325 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004326 }
4327 }
4328 break;
4329 default:
4330 break;
4331 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004332
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004333 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004334 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004335 skip |= ValidateCreateImageViewANDROID(device_data, pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004336 }
4337
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004338 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004339 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4340 : format_properties.optimalTilingFeatures;
4341
4342 if (tiling_features == 0) {
4343 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004344 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004345 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4346 "physical device.",
4347 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4348 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4349 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004350 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004351 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4352 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4353 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4354 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4355 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 -07004356 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004357 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4358 "VK_IMAGE_USAGE_STORAGE_BIT.",
4359 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4360 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4361 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4362 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 -07004363 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004364 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4365 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4366 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4367 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4368 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4369 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 -07004370 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004371 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4372 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4373 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004374 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004375
Jeff Bolz9af91c52018-09-01 21:53:57 -05004376 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4377 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4378 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 -07004379 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004380 "vkCreateImageView() If image was created with usage containing "
4381 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4382 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4383 }
4384 if (view_format != VK_FORMAT_R8_UINT) {
4385 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 -07004386 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004387 "vkCreateImageView() If image was created with usage containing "
4388 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4389 }
4390 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004391 }
4392 return skip;
4393}
4394
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004395void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4396 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004397 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004398 auto image_view_map = GetImageViewMap();
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004399 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004400
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004401 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004402 auto &sub_res_range = (*image_view_map)[*pView].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004403 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4404 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004405}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004406
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004407bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4408 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004409 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004410 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004411 auto src_buffer_state = GetBufferState(srcBuffer);
4412 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004413
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004414 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004415 skip |=
4416 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4417 skip |=
4418 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004419 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004420 skip |=
4421 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4422 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4423 skip |=
4424 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4425 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004426 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004427 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4428 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004429 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004430 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004431 return skip;
4432}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004433
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004434void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4435 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004436 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004437 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004438 auto src_buffer_state = GetBufferState(srcBuffer);
4439 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004440
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004441 // Update bindings between buffers and cmd buffer
4442 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4443 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004444}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004445
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004446bool CoreChecks::ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004447 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004448 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004449 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004450 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 -07004451 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4452 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004453 } else {
4454 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004455 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 -06004456 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004457 "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 -07004458 }
4459 }
4460 return skip;
4461}
4462
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004463bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004464 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004465 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004466 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4467
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004468 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004469 if (image_view_state) {
4470 skip |= ValidateObjectNotInUse(device_data, image_view_state, obj_struct, "vkDestroyImageView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004471 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004472 }
4473 return skip;
4474}
4475
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004476void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004477 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004478 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004479 if (!image_view_state) return;
4480 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4481
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004482 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004483 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004484 (*GetImageViewMap()).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004485}
4486
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004487bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004488 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004489 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004490
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004491 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004492 if (buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004493 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004494 }
4495 return skip;
4496}
4497
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004498void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004499 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4500 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004501 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004502 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4503
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004504 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004505 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004506 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004507 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004508 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004509 }
4510 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004511 ClearMemoryObjectBindings(HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004512 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004513 GetBufferMap()->erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004514}
4515
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004516bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4517 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004518 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004519 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004520 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004521 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004522 if (buffer_view_state) {
4523 skip |= ValidateObjectNotInUse(device_data, buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004524 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004525 }
4526 return skip;
4527}
4528
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004529void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004530 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4531 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004532 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004533 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4534
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004535 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004536 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004537 GetBufferViewMap()->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004538}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004539
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004540bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4541 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004542 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004543 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004544 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004545 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004546 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004547 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004548 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4549 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004550 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4551 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004552 skip |=
4553 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4554 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004555 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004556 return skip;
4557}
4558
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004559void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4560 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004561 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004562 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004563 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004564 // Update bindings between buffer and cmd buffer
4565 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004566}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004567
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004568bool CoreChecks::ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount,
4569 const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004570 bool skip = false;
4571
4572 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004573 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4574 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004575 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 -06004576 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004577 "%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 -06004578 "and 1, respectively.",
4579 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004580 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004581 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004582
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004583 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4584 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004585 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 -06004586 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004587 "%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 -06004588 "must be 0 and 1, respectively.",
4589 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004590 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004591 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004592
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004593 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4594 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004595 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 -06004596 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004597 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4598 "For 3D images these must be 0 and 1, respectively.",
4599 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004600 }
4601 }
4602
4603 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004604 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
4605 uint32_t element_size = FormatElementSize(image_state->createInfo.format);
4606 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004607 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 -06004608 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004609 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004610 " must be a multiple of this format's texel size (%" PRIu32 ").",
4611 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004612 }
4613
4614 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004615 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004616 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 -06004617 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004618 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4619 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004620 }
4621
4622 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4623 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004624 skip |=
4625 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004626 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004627 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4628 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004629 }
4630
4631 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4632 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4633 skip |= log_msg(
4634 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004635 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004636 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4637 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004638 }
4639
4640 // subresource aspectMask must have exactly 1 bit set
4641 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4642 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4643 if (aspect_mask_bits.count() != 1) {
4644 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 -06004645 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004646 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004647 }
4648
4649 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004650 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004651 skip |= log_msg(
4652 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004653 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004654 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4655 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004656 }
4657
4658 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004659 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004660 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004661
4662 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004663 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004664 skip |= log_msg(
4665 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004666 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004667 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4668 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004669 }
4670
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004671 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004672 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004673 skip |= log_msg(
4674 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004675 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004676 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4677 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004678 }
4679
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004680 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004681 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4682 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4683 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004684 skip |=
4685 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004686 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004687 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4688 "width & height (%d, %d)..",
4689 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004690 }
4691
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004692 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004693 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004694 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004695 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 -06004696 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004697 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004698 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004699 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004700 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004701
4702 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004703 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004704 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004705 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4706 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 -06004707 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004708 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004709 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004710 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004711 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004712 }
4713
4714 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004715 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004716 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4717 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 -06004718 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004719 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004720 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004721 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004722 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004723 }
4724
4725 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004726 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004727 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4728 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 -06004729 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004730 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004731 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004732 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004733 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004734 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004735 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004736 }
4737
4738 return skip;
4739}
4740
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004741static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004742 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004743 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004744 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004745
4746 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004747 VkExtent3D extent = pRegions[i].imageExtent;
4748 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004749
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004750 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4751 {
Dave Houlton51653902018-06-22 17:32:13 -06004752 skip |=
4753 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4754 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4755 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004756 }
4757
4758 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4759
4760 // 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 -06004761 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004762 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004763 if (image_extent.width % block_extent.width) {
4764 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4765 }
4766 if (image_extent.height % block_extent.height) {
4767 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4768 }
4769 if (image_extent.depth % block_extent.depth) {
4770 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4771 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004772 }
4773
Dave Houltonfc1a4052017-04-27 14:32:45 -06004774 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004775 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 -06004776 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004777 }
4778 }
4779
4780 return skip;
4781}
4782
Chris Forbese8ba09a2017-06-01 17:39:02 -07004783static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004784 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004785 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004786 bool skip = false;
4787
4788 VkDeviceSize buffer_size = buff_state->createInfo.size;
4789
4790 for (uint32_t i = 0; i < regionCount; i++) {
4791 VkExtent3D copy_extent = pRegions[i].imageExtent;
4792
4793 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4794 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houltona585d132019-01-18 13:05:42 -07004795 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004796
Dave Houltonf3229d52017-02-21 15:59:08 -07004797 // Handle special buffer packing rules for specific depth/stencil formats
4798 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houltona585d132019-01-18 13:05:42 -07004799 unit_size = FormatElementSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004800 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4801 switch (image_state->createInfo.format) {
4802 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004803 unit_size = FormatElementSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004804 break;
4805 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004806 unit_size = FormatElementSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004807 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004808 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004809 case VK_FORMAT_D24_UNORM_S8_UINT:
4810 unit_size = 4;
4811 break;
4812 default:
4813 break;
4814 }
4815 }
4816
Tom Cooperb2550c72018-10-15 13:08:41 +01004817 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004818 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004819 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004820 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4821 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4822
4823 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4824 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4825 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004826 }
4827
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004828 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4829 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4830 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004831 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004832 } else {
4833 // Calculate buffer offset of final copied byte, + 1.
4834 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4835 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4836 max_buffer_offset *= unit_size; // convert to bytes
4837 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004838
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004839 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004840 skip |=
4841 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4842 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004843 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004844 }
4845 }
4846
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004847 return skip;
4848}
4849
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004850bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4851 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004852 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004853 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004854 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004855 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004856
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004857 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4858
4859 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004860 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004861
4862 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004863 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004864
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004865 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004866
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004867 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4868 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 -06004869 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004870 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004871 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004872 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004873 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004874 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004875 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004876 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004877
4878 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004879 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4880 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4881 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4882 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4883 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004884
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004885 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004886 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4887 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4888 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004889 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004890 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4891 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004892 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04004893 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004894 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4895 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004896 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004897 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004898 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004899 const char *src_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004900 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004901 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4902 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004903 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004904 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4905 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004906 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004907 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4908 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004909 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004910 "vkCmdCopyImageToBuffer()",
4911 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004912 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4913 "vkCmdCopyImageToBuffer()", "imageSubresource",
4914 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4915 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4916 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4917 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004918 }
4919 return skip;
4920}
4921
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004922void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4923 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004924 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004925 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004926 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004927 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004928
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004929 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004930 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004931 SetImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004932 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004933 // Update bindings between buffer/image and cmd buffer
4934 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004935 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004936}
4937
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004938bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4939 VkImageLayout dstImageLayout, uint32_t regionCount,
4940 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004941 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004942 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004943 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004944 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004945
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004946 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4947
4948 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004949 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004950
4951 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004952 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004953 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004954 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4955 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 -06004956 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004957 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004958 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004959 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004960 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004961 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004962 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004963 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004964 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004965 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4966 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4967 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4968 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4969 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004970 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004971 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4972 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4973 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4974 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4975 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004976 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04004977 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004978 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4979 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004980 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004981 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004982 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004983 const char *dst_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004984 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004985 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4986 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004987 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004988 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4989 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004990 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004991 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4992 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004993 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004994 "vkCmdCopyBufferToImage()",
4995 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004996 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4997 "vkCmdCopyBufferToImage()", "imageSubresource",
4998 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4999 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
5000 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5001 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005002 }
5003 return skip;
5004}
5005
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005006void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5007 VkImageLayout dstImageLayout, uint32_t regionCount,
5008 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005009 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07005010 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005011 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005012 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005013
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005014 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005015 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005016 SetImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005017 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07005018 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005019 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005020}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005021
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005022bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5023 VkSubresourceLayout *pLayout) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07005024 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
5025 const auto report_data = device_data->report_data;
Mike Weiblen672b58b2017-02-21 14:32:53 -07005026 bool skip = false;
5027 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5028
Dave Houlton1d960ff2018-01-19 12:17:05 -07005029 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005030 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5031 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5032 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005033 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 -06005034 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005035 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005036 }
5037
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005038 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005039 if (!image_entry) {
5040 return skip;
5041 }
5042
Dave Houlton1d960ff2018-01-19 12:17:05 -07005043 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005044 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005045 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5046 "VUID-vkGetImageSubresourceLayout-image-00996",
5047 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005048 }
5049
Dave Houlton1d960ff2018-01-19 12:17:05 -07005050 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005051 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005052 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5053 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5054 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5055 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005056 }
5057
Dave Houlton1d960ff2018-01-19 12:17:05 -07005058 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005059 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005060 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5061 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5062 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5063 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005064 }
5065
Dave Houlton1d960ff2018-01-19 12:17:05 -07005066 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005067 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005068 if (FormatIsMultiplane(img_format)) {
5069 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005070 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005071 if (FormatPlaneCount(img_format) > 2u) {
5072 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005073 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005074 }
5075 if (sub_aspect != (sub_aspect & allowed_flags)) {
5076 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 -06005077 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005078 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005079 ") must be a single-plane specifier flag.",
5080 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005081 }
5082 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005083 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005084 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005085 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005086 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005087 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005088 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005089 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005090 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005091 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 -06005092 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005093 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005094 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005095 }
5096 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005097
Mark Lobodzinski60e79032019-03-07 10:22:31 -07005098 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005099 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
5100 }
5101
Mike Weiblen672b58b2017-02-21 14:32:53 -07005102 return skip;
5103}