blob: 05102a96c5fe073dce28fd65e595ffb79690d852 [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 Lobodzinski76d76662019-02-14 14:38:21 -070037#include "core_validation.h"
38#include "shader_validation.h"
39#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070040#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070041
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -070042namespace core_validation {
43extern unordered_map<void *, layer_data *> layer_data_map;
44extern unordered_map<void *, instance_layer_data *> instance_layer_data_map;
45}; // namespace core_validation
46
47using core_validation::instance_layer_data_map;
48using core_validation::layer_data_map;
49
Dave Houltond9611312018-11-19 17:03:36 -070050uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
51 // uint cast applies floor()
52 return 1u + (uint32_t)log2(std::max({height, width, depth}));
53}
54
55uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
56
57uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
58
Tobin Ehlis58c884f2017-02-08 12:15:27 -070059void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070060 auto it = pCB->imageLayoutMap.find(imgpair);
61 if (it != pCB->imageLayoutMap.end()) {
62 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070063 } else {
64 assert(imgpair.hasSubresource);
65 IMAGE_CMD_BUF_LAYOUT_NODE node;
66 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
67 node.initialLayout = layout;
68 }
69 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
70 }
71}
72template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070073void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070074 ImageSubresourcePair imgpair = {image, true, range};
75 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
76 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
77 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
78 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -070079 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
80 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
81 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
82 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
83 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070084}
85
86template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070087void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070088 VkImageAspectFlags aspectMask) {
89 if (imgpair.subresource.aspectMask & aspectMask) {
90 imgpair.subresource.aspectMask = aspectMask;
91 SetLayout(device_data, pObject, imgpair, layout);
92 }
93}
94
Tony Barbourdf013b92017-01-25 12:53:48 -070095// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070096void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
97 VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070098 auto it = imageLayoutMap.find(imgpair);
99 if (it != imageLayoutMap.end()) {
100 it->second.layout = layout; // Update
101 } else {
102 imageLayoutMap[imgpair].layout = layout; // Insert
103 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700104}
105
Tobin Ehlisc8266452017-04-07 12:20:30 -0600106bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700107 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
108 const debug_report_data *report_data = core_validation::GetReportData(device_data);
109
110 if (!(imgpair.subresource.aspectMask & aspectMask)) {
111 return false;
112 }
113 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
114 imgpair.subresource.aspectMask = aspectMask;
115 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
116 if (imgsubIt == pCB->imageLayoutMap.end()) {
117 return false;
118 }
119 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200120 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 -0600121 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700122 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
123 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700124 string_VkImageLayout(imgsubIt->second.layout));
125 }
126 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200127 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 -0600128 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700129 "Cannot query for VkImage %s"
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700130 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700131 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700132 string_VkImageLayout(imgsubIt->second.initialLayout));
133 }
134 node = imgsubIt->second;
135 return true;
136}
137
Tobin Ehlisc8266452017-04-07 12:20:30 -0600138bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700139 const VkImageAspectFlags aspectMask) {
140 if (!(imgpair.subresource.aspectMask & aspectMask)) {
141 return false;
142 }
143 const debug_report_data *report_data = core_validation::GetReportData(device_data);
144 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
145 imgpair.subresource.aspectMask = aspectMask;
146 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
147 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
148 return false;
149 }
150 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200151 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 -0600152 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700153 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
154 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700155 string_VkImageLayout(imgsubIt->second.layout));
156 }
157 layout = imgsubIt->second.layout;
158 return true;
159}
160
161// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600162bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700163 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
164 ImageSubresourcePair imgpair = {image, true, range};
165 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
166 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
167 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
168 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
169 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700170 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
171 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
172 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
173 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
174 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700175 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
176 imgpair = {image, false, VkImageSubresource()};
177 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
178 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
179 // TODO: This is ostensibly a find function but it changes state here
180 node = imgsubIt->second;
181 }
182 return true;
183}
184
185// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700186bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700187 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
188 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
189 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
190 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
191 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700192 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
193 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
194 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
195 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
196 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700197 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
198 imgpair = {imgpair.image, false, VkImageSubresource()};
199 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
200 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
201 layout = imgsubIt->second.layout;
202 }
203 return true;
204}
205
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700206bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
208 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700209 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700210 if (!image_state) return false;
211 bool ignoreGlobal = false;
212 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
213 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
214 ignoreGlobal = true;
215 }
216 for (auto imgsubpair : sub_data->second) {
217 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
218 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
219 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
220 layouts.push_back(img_data->second.layout);
221 }
222 }
223 return true;
224}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700225bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
226 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700227 if (!(imgpair.subresource.aspectMask & aspectMask)) {
228 return false;
229 }
230 imgpair.subresource.aspectMask = aspectMask;
231 auto imgsubIt = imageLayoutMap.find(imgpair);
232 if (imgsubIt == imageLayoutMap.end()) {
233 return false;
234 }
235 layout = imgsubIt->second.layout;
236 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700237}
Tony Barbourdf013b92017-01-25 12:53:48 -0700238
239// find layout in supplied map
Dave Houltonb3f4b282018-02-22 16:25:16 -0700240bool FindLayout(layer_data *device_data, const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
241 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700242 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
243 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
244 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
245 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
246 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700247 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
248 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
249 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
250 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
251 }
252 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700253 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
254 imgpair = {imgpair.image, false, VkImageSubresource()};
255 auto imgsubIt = imageLayoutMap.find(imgpair);
256 if (imgsubIt == imageLayoutMap.end()) return false;
257 layout = imgsubIt->second.layout;
258 }
259 return true;
260}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700261
262// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700263void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700264 VkImage &image = imgpair.image;
Dave Houltonb3f4b282018-02-22 16:25:16 -0700265 auto &lmap = (*core_validation::GetImageLayoutMap(device_data));
266 auto data = lmap.find(imgpair);
267 if (data != lmap.end()) {
268 data->second.layout = layout; // Update
269 } else {
270 lmap[imgpair].layout = layout; // Insert
271 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700272 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
273 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
274 if (subresource == image_subresources.end()) {
275 image_subresources.push_back(imgpair);
276 }
277}
278
279// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700280void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700281 auto it = pCB->imageLayoutMap.find(imgpair);
282 if (it != pCB->imageLayoutMap.end()) {
283 it->second = node; // Update
284 } else {
285 pCB->imageLayoutMap[imgpair] = node; // Insert
286 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700287}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600288// Set image layout for given VkImageSubresourceRange struct
289void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
290 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
291 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700292 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600293 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
294 uint32_t level = image_subresource_range.baseMipLevel + level_index;
295 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
296 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
297 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700298 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
299 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600300 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600301 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700302 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
303 }
304 }
Tony-LunarG119b38a2018-12-18 09:49:16 -0700305 // For multiplane images, IMAGE_ASPECT_COLOR is an alias for all of the plane bits
306 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
307 if (FormatIsMultiplane(image_state->createInfo.format)) {
308 if (sub.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
309 sub.aspectMask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
310 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR;
311 if (FormatPlaneCount(image_state->createInfo.format) > 2) {
312 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
313 }
314 }
315 }
316 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600317 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700318 }
319 }
320}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600321// Set image layout for given VkImageSubresourceLayers struct
322void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
323 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
324 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
325 VkImageSubresourceRange image_subresource_range;
326 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
327 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
328 image_subresource_range.layerCount = image_subresource_layers.layerCount;
329 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
330 image_subresource_range.levelCount = 1;
331 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
332}
Dave Houltonddd65c52018-05-08 14:58:01 -0600333
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600334// Set image layout for all slices of an image view
John Zulauf4ccf5c02018-09-21 11:46:18 -0600335void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_VIEW_STATE *view_state,
336 const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600337 assert(view_state);
338
Dave Houltonddd65c52018-05-08 14:58:01 -0600339 IMAGE_STATE *image_state = GetImageState(device_data, view_state->create_info.image);
340 VkImageSubresourceRange sub_range = view_state->create_info.subresourceRange;
341
342 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
343 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
344 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state->create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
345 sub_range.baseArrayLayer = 0;
346 sub_range.layerCount = image_state->createInfo.extent.depth;
347 }
348
349 SetImageLayout(device_data, cb_node, image_state, sub_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600350}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700351
John Zulauf4ccf5c02018-09-21 11:46:18 -0600352void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
353 auto view_state = GetImageViewState(device_data, imageView);
354 SetImageViewLayout(device_data, cb_node, view_state, layout);
355}
356
Tobias Hectorbbb12282018-10-22 15:17:59 +0100357bool ValidateRenderPassLayoutAgainstFramebufferImageUsage(layer_data *device_data, RenderPassCreateVersion rp_version,
358 VkImageLayout layout, VkImage image, VkImageView image_view,
359 VkFramebuffer framebuffer, VkRenderPass renderpass,
360 uint32_t attachment_index, const char *variable_name) {
361 bool skip = false;
362 const auto report_data = core_validation::GetReportData(device_data);
363 auto image_state = GetImageState(device_data, image);
364 const char *vuid;
365 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
366
367 if (!image_state) {
368 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
369 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Lockee9aeebf2019-03-03 23:50:08 -0700370 "Render Pass begin with renderpass %s uses framebuffer %s where pAttachments[%" PRIu32
371 "] = image view %s, which refers to an invalid image",
372 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
373 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100374 return skip;
375 }
376
377 auto image_usage = image_state->createInfo.usage;
378
379 // Check for layouts that mismatch image usages in the framebuffer
380 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
381 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
382 skip |=
383 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700384 "Layout/usage mismatch for attachment %u in render pass %s"
385 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100386 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700387 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
388 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100389 }
390
391 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
392 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
393 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
394 skip |=
395 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 -0700396 "Layout/usage mismatch for attachment %u in render pass %s"
397 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100398 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700399 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
400 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100401 }
402
403 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
404 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
405 skip |=
406 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 -0700407 "Layout/usage mismatch for attachment %u in render pass %s"
408 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100409 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700410 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
411 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100412 }
413
414 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
415 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
416 skip |=
417 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 -0700418 "Layout/usage mismatch for attachment %u in render pass %s"
419 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100420 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700421 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
422 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100423 }
424
425 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
426 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
427 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
428 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
429 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
430 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
431 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700432 skip |= log_msg(
433 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
434 "Layout/usage mismatch for attachment %u in render pass %s"
435 " - the %s is %s but the image attached to framebuffer %s via image view %s"
436 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
437 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
438 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100439 }
440 } else {
441 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
442 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
443 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
444 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
445 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
446 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Lockee9aeebf2019-03-03 23:50:08 -0700447 "Layout/usage mismatch for attachment %u in render pass %s"
448 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100449 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700450 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name,
451 string_VkImageLayout(layout), report_data->FormatHandle(renderpass).c_str(),
452 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100453 }
454 }
455 return skip;
456}
457
458bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700459 const VkRenderPassBeginInfo *pRenderPassBegin,
460 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600461 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700462 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700463 auto const &framebufferInfo = framebuffer_state->createInfo;
464 const auto report_data = core_validation::GetReportData(device_data);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100465
466 auto render_pass = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->renderPass;
467 auto framebuffer = framebuffer_state->framebuffer;
468
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700469 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600470 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 -0600471 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700472 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700473 }
474 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
475 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700476 auto view_state = GetImageViewState(device_data, image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600477
478 if (!view_state) {
Lockee9aeebf2019-03-03 23:50:08 -0700479 skip |=
480 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
481 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
482 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
483 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
484 report_data->FormatHandle(image_view).c_str());
John Zulauf8e308292018-09-21 11:34:37 -0600485 continue;
486 }
487
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700488 const VkImage &image = view_state->create_info.image;
489 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700490 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100491 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
492
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700493 // TODO: Do not iterate over every possibility - consolidate where possible
494 for (uint32_t j = 0; j < subRange.levelCount; j++) {
495 uint32_t level = subRange.baseMipLevel + j;
496 for (uint32_t k = 0; k < subRange.layerCount; k++) {
497 uint32_t layer = subRange.baseArrayLayer + k;
498 VkImageSubresource sub = {subRange.aspectMask, level, layer};
499 IMAGE_CMD_BUF_LAYOUT_NODE node;
500 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700501 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700502 continue;
503 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700504 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600505 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 -0600506 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700507 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
508 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
509 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600510 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700511 }
512 }
513 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100514
515 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, initial_layout, image, image_view,
516 framebuffer, render_pass, i, "initial layout");
517
518 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, final_layout, image, image_view, framebuffer,
519 render_pass, i, "final layout");
520 }
521
522 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
523 auto &subpass = pRenderPassInfo->pSubpasses[j];
524 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
525 auto &attachment_ref = subpass.pInputAttachments[k];
526 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
527 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
528 auto view_state = GetImageViewState(device_data, image_view);
529
530 if (view_state) {
531 auto image = view_state->create_info.image;
532 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
533 image_view, framebuffer, render_pass,
534 attachment_ref.attachment, "input attachment layout");
535 }
536 }
537 }
538
539 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
540 auto &attachment_ref = subpass.pColorAttachments[k];
541 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
542 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
543 auto view_state = GetImageViewState(device_data, image_view);
544
545 if (view_state) {
546 auto image = view_state->create_info.image;
547 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
548 image_view, framebuffer, render_pass,
549 attachment_ref.attachment, "color attachment layout");
550 if (subpass.pResolveAttachments) {
551 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
552 device_data, rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
553 attachment_ref.attachment, "resolve attachment layout");
554 }
555 }
556 }
557 }
558
559 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
560 auto &attachment_ref = *subpass.pDepthStencilAttachment;
561 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
562 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
563 auto view_state = GetImageViewState(device_data, image_view);
564
565 if (view_state) {
566 auto image = view_state->create_info.image;
567 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
568 image_view, framebuffer, render_pass,
569 attachment_ref.attachment, "input attachment layout");
570 }
571 }
572 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700573 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600574 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575}
576
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700577void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Tobias Hectorbbb12282018-10-22 15:17:59 +0100578 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700579 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf8e308292018-09-21 11:34:37 -0600580 auto image_view = GetAttachmentImageViewState(device_data, pFramebuffer, ref.attachment);
581 if (image_view) {
582 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
583 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700584 }
585}
586
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700587void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700588 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700589 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700590
591 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700592 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700593 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
594 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
595 }
596 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
597 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
598 }
599 if (subpass.pDepthStencilAttachment) {
600 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
601 }
602 }
603}
604
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600605bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700606 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700607 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
608 return false;
609 }
610 VkImageSubresource sub = {aspect, level, layer};
611 IMAGE_CMD_BUF_LAYOUT_NODE node;
612 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700613 return false;
614 }
615 bool skip = false;
616 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
617 // TODO: Set memory invalid which is in mem_tracker currently
618 } else if (node.layout != mem_barrier->oldLayout) {
Lockee9aeebf2019-03-03 23:50:08 -0700619 skip = log_msg(
620 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
621 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
622 "VUID-VkImageMemoryBarrier-oldLayout-01197",
623 "For image %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
624 core_validation::GetReportData(device_data)->FormatHandle(mem_barrier->image).c_str(), aspect, level, layer,
625 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700626 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700627 return skip;
628}
629
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700630// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
631// 1. Transition into initialLayout state
632// 2. Transition from initialLayout to layout used in subpass 0
633void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
634 FRAMEBUFFER_STATE *framebuffer_state) {
635 // First transition into initialLayout
636 auto const rpci = render_pass_state->createInfo.ptr();
637 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -0600638 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
639 if (view_state) {
640 SetImageViewLayout(device_data, cb_state, view_state, rpci->pAttachments[i].initialLayout);
641 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700642 }
643 // Now transition for first subpass (index 0)
644 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
645}
646
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700647void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
Tony-LunarG0d27b302018-10-08 09:26:21 -0600648 uint32_t level, uint32_t layer, VkImageAspectFlags aspect_mask, VkImageAspectFlags aspect) {
649 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700650 return;
651 }
652 VkImageSubresource sub = {aspect, level, layer};
653 IMAGE_CMD_BUF_LAYOUT_NODE node;
654 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700655 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700656 SetLayout(device_data, pCB, mem_barrier->image, sub,
657 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
658 return;
659 }
660 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
661 // TODO: Set memory invalid
662 }
663 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
664}
665
Dave Houlton10b39482017-03-16 13:18:15 -0600666bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600667 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600668 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600669 }
670 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600671 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600672 }
673 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600674 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600675 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700676 if (0 !=
677 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
678 if (FormatPlaneCount(format) == 1) return false;
679 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600680 return true;
681}
682
Mike Weiblen62d08a32017-03-07 22:18:27 -0700683// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
684bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
685 VkImageUsageFlags usage_flags, const char *func_name) {
686 const auto report_data = core_validation::GetReportData(device_data);
687 bool skip = false;
688 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600689 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700690
691 switch (layout) {
692 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
693 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600694 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700695 }
696 break;
697 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
698 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600699 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700700 }
701 break;
702 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
703 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600704 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700705 }
706 break;
707 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
708 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600709 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700710 }
711 break;
712 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
713 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600714 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700715 }
716 break;
717 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
718 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600719 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700720 }
721 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600722 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500723 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
724 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
725 }
726 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700727 default:
728 // Other VkImageLayout values do not have VUs defined in this context.
729 break;
730 }
731
Dave Houlton8e9f6542018-05-18 12:18:22 -0600732 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600733 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 -0600734 HandleToUint64(img_barrier->image), msg_code,
Lockee9aeebf2019-03-03 23:50:08 -0700735 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image %s usage flags 0x%" PRIx32 ".", func_name,
736 static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
737 report_data->FormatHandle(img_barrier->image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700738 }
739 return skip;
740}
741
John Zulauf463c51e2018-05-31 13:29:20 -0600742// Scoreboard for checking for duplicate and inconsistent barriers to images
743struct ImageBarrierScoreboardEntry {
744 uint32_t index;
745 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
746 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
747 const VkImageMemoryBarrier *barrier;
748};
749using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
750using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
751
Mike Weiblen62d08a32017-03-07 22:18:27 -0700752// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600753bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700754 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700755 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700756
John Zulauf463c51e2018-05-31 13:29:20 -0600757 // Scoreboard for duplicate layout transition barriers within the list
758 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
759 ImageBarrierScoreboardImageMap layout_transitions;
760
Mike Weiblen62d08a32017-03-07 22:18:27 -0700761 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
762 auto img_barrier = &pImageMemoryBarriers[i];
763 if (!img_barrier) continue;
764
John Zulauf463c51e2018-05-31 13:29:20 -0600765 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
766 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
767 // at a per sub-resource level
768 if (img_barrier->oldLayout != img_barrier->newLayout) {
769 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
770 auto image_it = layout_transitions.find(img_barrier->image);
771 if (image_it != layout_transitions.end()) {
772 auto &subres_map = image_it->second;
773 auto subres_it = subres_map.find(img_barrier->subresourceRange);
774 if (subres_it != subres_map.end()) {
775 auto &entry = subres_it->second;
776 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
777 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
778 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
779 skip = log_msg(
780 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
781 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_state->commandBuffer),
782 "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700783 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600784 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
785 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Lockee9aeebf2019-03-03 23:50:08 -0700786 func_name, i, entry.index,
787 core_validation::GetReportData(device_data)->FormatHandle(img_barrier->image).c_str(), range.aspectMask,
788 range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
789 string_VkImageLayout(img_barrier->oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600790 }
791 entry = new_entry;
792 } else {
793 subres_map[img_barrier->subresourceRange] = new_entry;
794 }
795 } else {
796 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
797 }
798 }
799
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600800 auto image_state = GetImageState(device_data, img_barrier->image);
801 if (image_state) {
802 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
803 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
804 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
805
806 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
807 if (image_state->layout_locked) {
808 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600809 skip |= log_msg(
810 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Young9d1ac312018-05-21 16:28:27 -0600811 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), 0,
Lockee9aeebf2019-03-03 23:50:08 -0700812 "Attempting to transition shared presentable image %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600813 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Lockee9aeebf2019-03-03 23:50:08 -0700814 core_validation::GetReportData(device_data)->FormatHandle(img_barrier->image).c_str(),
815 string_VkImageLayout(img_barrier->oldLayout), string_VkImageLayout(img_barrier->newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600816 }
817 }
818
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600819 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600820 // For a Depth/Stencil image both aspects MUST be set
821 if (FormatIsDepthAndStencil(image_create_info->format)) {
822 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
823 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
824 if ((aspect_mask & ds_mask) != (ds_mask)) {
Lockee9aeebf2019-03-03 23:50:08 -0700825 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
826 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image),
827 "VUID-VkImageMemoryBarrier-image-01207",
828 "%s: Image barrier 0x%p references image %s of format %s that must have the depth and stencil "
829 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
830 func_name, static_cast<const void *>(img_barrier),
831 core_validation::GetReportData(device_data)->FormatHandle(img_barrier->image).c_str(),
832 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600833 }
834 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600835 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
836 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700837
Mike Weiblen62d08a32017-03-07 22:18:27 -0700838 for (uint32_t j = 0; j < level_count; j++) {
839 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
840 for (uint32_t k = 0; k < layer_count; k++) {
841 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600842 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
843 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
844 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
845 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700846 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
847 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
848 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
849 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
850 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
851 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
852 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
853 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700854 }
855 }
856 }
857 return skip;
858}
859
Chris Forbes4de4b132017-08-21 11:27:08 -0700860static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600861 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700862
863 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600864 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700865}
866
John Zulauf6b4aae82018-05-09 13:03:36 -0600867template <typename Barrier>
868bool ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
869 uint32_t barrier_count, const Barrier *barriers) {
870 using BarrierRecord = QFOTransferBarrier<Barrier>;
871 bool skip = false;
872 const auto report_data = core_validation::GetReportData(device_data);
873 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
874 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
875 const char *barrier_name = BarrierRecord::BarrierName();
876 const char *handle_name = BarrierRecord::HandleName();
877 const char *transfer_type = nullptr;
878 for (uint32_t b = 0; b < barrier_count; b++) {
879 if (!IsTransferOp(&barriers[b])) continue;
880 const BarrierRecord *barrier_record = nullptr;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600881 if (IsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600882 const auto found = barrier_sets.release.find(barriers[b]);
883 if (found != barrier_sets.release.cend()) {
884 barrier_record = &(*found);
885 transfer_type = "releasing";
886 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600887 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
888 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600889 const auto found = barrier_sets.acquire.find(barriers[b]);
890 if (found != barrier_sets.acquire.cend()) {
891 barrier_record = &(*found);
892 transfer_type = "acquiring";
893 }
894 }
895 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700896 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
897 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
898 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
899 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
900 func_name, barrier_name, b, transfer_type, handle_name,
901 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
902 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600903 }
904 }
905 return skip;
906}
907
908template <typename Barrier>
909void RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
910 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
911 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
912 for (uint32_t b = 0; b < barrier_count; b++) {
913 if (!IsTransferOp(&barriers[b])) continue;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600914 if (IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600915 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600916 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
917 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600918 barrier_sets.acquire.emplace(barriers[b]);
919 }
920 }
921}
922
923bool ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
924 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
925 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
926 bool skip = false;
927 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
928 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
929 return skip;
930}
931
Mark Lobodzinskibf0400a2019-01-30 16:32:31 -0700932void RecordBarriersQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
933 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
934 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600935 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
936 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
937}
938
939template <typename BarrierRecord, typename Scoreboard>
940static bool ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
941 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
942 // Record to the scoreboard or report that we have a duplication
943 bool skip = false;
944 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
945 if (!inserted.second && inserted.first->second != cb_state) {
946 // 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 -0700947 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
948 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
949 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
950 " duplicates existing barrier submitted in this batch from command buffer %s.",
951 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
952 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
953 report_data->FormatHandle(inserted.first->second).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600954 }
955 return skip;
956}
957
958template <typename Barrier>
959static bool ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
960 QFOTransferCBScoreboards<Barrier> *scoreboards) {
961 using BarrierRecord = QFOTransferBarrier<Barrier>;
962 using TypeTag = typename BarrierRecord::Tag;
963 bool skip = false;
964 const auto report_data = core_validation::GetReportData(device_data);
965 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
966 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
967 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
968 const char *barrier_name = BarrierRecord::BarrierName();
969 const char *handle_name = BarrierRecord::HandleName();
970 // No release should have an extant duplicate (WARNING)
971 for (const auto &release : cb_barriers.release) {
972 // Check the global pending release barriers
973 const auto set_it = global_release_barriers.find(release.handle);
974 if (set_it != global_release_barriers.cend()) {
975 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
976 const auto found = set_for_handle.find(release);
977 if (found != set_for_handle.cend()) {
978 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
979 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700980 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600981 " to dstQueueFamilyIndex %" PRIu32
982 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700983 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600984 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
985 }
986 }
987 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
988 }
989 // Each acquire must have a matching release (ERROR)
990 for (const auto &acquire : cb_barriers.acquire) {
991 const auto set_it = global_release_barriers.find(acquire.handle);
992 bool matching_release_found = false;
993 if (set_it != global_release_barriers.cend()) {
994 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
995 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
996 }
997 if (!matching_release_found) {
998 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
999 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -07001000 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1001 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1002 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001003 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
1004 }
1005 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1006 }
1007 return skip;
1008}
1009
1010bool ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
1011 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
1012 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
1013 bool skip = false;
1014 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
1015 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
1016 return skip;
1017}
1018
1019template <typename Barrier>
1020static void RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1021 using BarrierRecord = QFOTransferBarrier<Barrier>;
1022 using TypeTag = typename BarrierRecord::Tag;
1023 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
1024 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1025 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
1026
1027 // Add release barriers from this submit to the global map
1028 for (const auto &release : cb_barriers.release) {
1029 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1030 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1031 global_release_barriers[release.handle].insert(release);
1032 }
1033
1034 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1035 for (const auto &acquire : cb_barriers.acquire) {
1036 // NOTE: We're not using [] because we don't want to create entries for missing releases
1037 auto set_it = global_release_barriers.find(acquire.handle);
1038 if (set_it != global_release_barriers.end()) {
1039 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1040 set_for_handle.erase(acquire);
1041 if (set_for_handle.size() == 0) { // Clean up empty sets
1042 global_release_barriers.erase(set_it);
1043 }
1044 }
1045 }
1046}
1047
1048void RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1049 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1050 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1051}
1052
1053// Remove the pending QFO release records from the global set
1054// Note that the type of the handle argument constrained to match Barrier type
1055// The defaulted BarrierRecord argument allows use to declare the type once, but is not intended to be specified by the caller
1056template <typename Barrier, typename BarrierRecord = QFOTransferBarrier<Barrier>>
1057static void EraseQFOReleaseBarriers(layer_data *device_data, const typename BarrierRecord::HandleType &handle) {
1058 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1059 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, typename BarrierRecord::Tag());
1060 global_release_barriers.erase(handle);
1061}
1062
1063// Avoid making the template globally visible by exporting the one instance of it we need.
1064void EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
1065 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1066}
1067
Chris Forbes399a6782017-08-18 15:00:48 -07001068void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001069 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001070 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1071 auto mem_barrier = &pImgMemBarriers[i];
1072 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001073
Chris Forbes4de4b132017-08-21 11:27:08 -07001074 // For ownership transfers, the barrier is specified twice; as a release
1075 // operation on the yielding queue family, and as an acquire operation
1076 // on the acquiring queue family. This barrier may also include a layout
1077 // transition, which occurs 'between' the two operations. For validation
1078 // purposes it doesn't seem important which side performs the layout
1079 // transition, but it must not be performed twice. We'll arbitrarily
1080 // choose to perform it as part of the acquire operation.
1081 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
1082 continue;
1083 }
1084
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001085 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
1086 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1087 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1088
Dave Houltonb3f4b282018-02-22 16:25:16 -07001089 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1090 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1091 // for all (potential) layer sub_resources.
1092 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1093 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1094 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1095 }
1096
Tony-LunarG0d27b302018-10-08 09:26:21 -06001097 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1098 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
1099 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1100 if (FormatIsMultiplane(image_create_info->format)) {
1101 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1102 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1103 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1104 if (FormatPlaneCount(image_create_info->format) > 2) {
1105 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1106 }
1107 }
1108 }
1109 }
1110
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001111 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001112 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001113 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001114 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Tony-LunarG0d27b302018-10-08 09:26:21 -06001115 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1116 VK_IMAGE_ASPECT_COLOR_BIT);
1117 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1118 VK_IMAGE_ASPECT_DEPTH_BIT);
1119 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1120 VK_IMAGE_ASPECT_STENCIL_BIT);
1121 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1122 VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001123 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001124 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1125 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1126 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1127 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1128 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1129 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001130 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001131 }
1132 }
1133 }
1134}
1135
Tobin Ehlisc8266452017-04-07 12:20:30 -06001136bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001137 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Jeff Bolzfdd0d852019-02-03 21:55:12 -06001138 const char *caller, const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001139 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001140 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001141 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001142
1143 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1144 uint32_t layer = i + subLayers.baseArrayLayer;
1145 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1146 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001147 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1148 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001149 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001150 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1151 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001152 "%s: Cannot use image %s (layer=%u mip=%u) with specific layout %s that doesn't match the actual "
1153 "current layout %s.",
1154 caller, report_data->FormatHandle(image).c_str(), layer, subLayers.mipLevel,
1155 string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001156 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001157 }
1158 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001159 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1160 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1161 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001162 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1163 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001164 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001165 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001166 kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07001167 "%s: For optimal performance image %s layout should be %s instead of GENERAL.", caller,
1168 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001169 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001170 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001171 if (image_state->shared_presentable) {
1172 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001173 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1174 layout_invalid_msg_code,
1175 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1176 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001177 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001178 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001179 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001180 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001181 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 -07001182 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001183 "%s: Layout for image %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1184 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1185 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001186 }
1187 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001188 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001189}
1190
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001191void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
1192 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001193 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001194 if (!renderPass) return;
1195
Tobias Hectorbbb12282018-10-22 15:17:59 +01001196 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001197 if (framebuffer_state) {
1198 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -06001199 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
1200 if (view_state) {
1201 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
1202 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001203 }
1204 }
1205}
Dave Houltone19e20d2018-02-02 16:32:41 -07001206
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001207#ifdef VK_USE_PLATFORM_ANDROID_KHR
1208// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1209// This could also move into a seperate core_validation_android.cpp file... ?
1210
1211//
1212// AHB-specific validation within non-AHB APIs
1213//
1214bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1215 const VkImageCreateInfo *create_info) {
1216 bool skip = false;
1217
1218 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1219 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001220 if (0 != ext_fmt_android->externalFormat) {
1221 if (VK_FORMAT_UNDEFINED != create_info->format) {
1222 skip |=
1223 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1224 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001225 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001226 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1227 }
1228
1229 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1230 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1231 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001232 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001233 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1234 }
1235
1236 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1237 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1238 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001239 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001240 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1241 }
1242
1243 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1244 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1245 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001246 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001247 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1248 }
1249 }
1250
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001251 auto ahb_formats = GetAHBExternalFormatsSet(device_data);
1252 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1253 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1254 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001255 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001256 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1257 }
1258 }
1259
Dave Houltond9611312018-11-19 17:03:36 -07001260 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001261 if (VK_FORMAT_UNDEFINED == create_info->format) {
1262 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1263 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001264 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001265 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1266 }
1267 }
1268
1269 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1270 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1271 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001272 skip |=
1273 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1274 "VUID-VkImageCreateInfo-pNext-02393",
1275 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1276 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1277 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001278 }
1279
1280 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1281 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1282 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001283 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001284 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1285 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1286 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1287 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001288 }
1289
1290 return skip;
1291}
1292
1293void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
1294 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1295 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1296 is_node->imported_ahb = true;
1297 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001298 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001299 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001300 is_node->has_ahb_format = true;
1301 is_node->ahb_format = ext_fmt_android->externalFormat;
1302 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001303}
1304
1305bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
1306 bool skip = false;
1307 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houltond3e046d2018-11-28 13:08:09 -07001308 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
1309
1310 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001311 if (VK_FORMAT_UNDEFINED != create_info->format) {
1312 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1313 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1314 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1315 "format member is %s.",
1316 string_VkFormat(create_info->format));
1317 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001318
Dave Houltond9611312018-11-19 17:03:36 -07001319 // Chain must include a compatible ycbcr conversion
1320 bool conv_found = false;
1321 uint64_t external_format = 0;
1322 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1323 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001324 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
1325 auto fmap = GetYcbcrConversionFormatMap(device_data);
Dave Houltond9611312018-11-19 17:03:36 -07001326 if (fmap->find(conv_handle) != fmap->end()) {
1327 conv_found = true;
1328 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001329 }
Dave Houltond9611312018-11-19 17:03:36 -07001330 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001331 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001332 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 -07001333 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1334 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1335 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1336 }
1337
1338 // Errors in create_info swizzles
1339 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1340 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1341 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1342 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1343 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1344 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1345 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1346 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001347 }
1348 }
Dave Houltond9611312018-11-19 17:03:36 -07001349
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001350 return skip;
1351}
1352
1353bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
1354 bool skip = false;
1355 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1356
1357 IMAGE_STATE *image_state = GetImageState(device_data, image);
1358 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1359 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1360 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001361 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001362 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1363 "bound to memory.");
1364 }
1365 return skip;
1366}
1367
1368#else
1369
1370bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1371 const VkImageCreateInfo *create_info) {
1372 return false;
1373}
1374
1375void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
1376
1377bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
1378
1379bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
1380
1381#endif // VK_USE_PLATFORM_ANDROID_KHR
1382
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001383bool PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
1384 VkImage *pImage) {
1385 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), core_validation::layer_data_map);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001386 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001387 const debug_report_data *report_data = GetReportData(device_data);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001388
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001389 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1390 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1391 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1392 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1393 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1394 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001395 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001396 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001397 }
1398
Dave Houlton130c0212018-01-29 13:39:56 -07001399 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001400 skip |= log_msg(
1401 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1402 "VUID-VkImageCreateInfo-flags-00949",
1403 "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 -07001404 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001405
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07001406 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001407 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1408 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1409 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001410 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 +00001411 "VUID-VkImageCreateInfo-usage-00964",
1412 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1413 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001414 }
1415
1416 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001417 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 +00001418 "VUID-VkImageCreateInfo-usage-00965",
1419 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1420 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001421 }
1422
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001423 VkImageFormatProperties format_limits = {};
1424 VkResult res = GetPDImageFormatProperties(device_data, pCreateInfo, &format_limits);
1425 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1426 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1427 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1428 string_VkFormat(pCreateInfo->format));
1429 } else {
1430 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1431 const char *format_string = string_VkFormat(pCreateInfo->format);
1432 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1433 "VUID-VkImageCreateInfo-mipLevels-02255",
1434 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1435 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1436 }
Dave Houlton130c0212018-01-29 13:39:56 -07001437
Dave Houltona585d132019-01-18 13:05:42 -07001438 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1439 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1440 (uint64_t)pCreateInfo->samples;
1441 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001442
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001443 // Round up to imageGranularity boundary
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07001444 VkDeviceSize imageGranularity = GetPDProperties(device_data)->limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001445 uint64_t ig_mask = imageGranularity - 1;
1446 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001447
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001448 if (total_size > format_limits.maxResourceSize) {
1449 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1450 kVUID_Core_Image_InvalidFormatLimitsViolation,
1451 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1452 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1453 total_size, format_limits.maxResourceSize);
1454 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001455
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001456 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1457 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1458 "VUID-VkImageCreateInfo-arrayLayers-02256",
1459 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1460 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1461 }
1462
1463 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1464 skip |=
1465 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1466 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001467 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001468 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001469 }
1470
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06001471 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) &&
1472 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001473 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 -06001474 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001475 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1476 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001477 }
1478
Lenny Komowb79f04a2017-09-18 17:07:00 -06001479 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1480 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1481 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1482 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1483 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001484 skip |=
1485 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1486 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1487 "format must be block, ETC or ASTC compressed, but is %s",
1488 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001489 }
1490 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1491 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001492 skip |=
1493 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1494 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1495 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001496 }
1497 }
1498 }
1499
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001500 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
1501 skip |= core_validation::ValidateQueueFamilies(
1502 device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1503 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1504 "VUID-VkImageCreateInfo-sharingMode-01420", false);
1505 }
1506
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001507 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001508}
1509
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001510void PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001511 VkImage *pImage, VkResult result) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001512 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), core_validation::layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001513 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001514 IMAGE_LAYOUT_NODE image_state;
1515 image_state.layout = pCreateInfo->initialLayout;
1516 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001517 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
1518 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1519 RecordCreateImageANDROID(pCreateInfo, is_node);
1520 }
1521 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001522 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001523 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1524 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001525}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001526
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001527bool PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1528 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
1529 IMAGE_STATE *image_state = core_validation::GetImageState(device_data, image);
1530 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001531 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001532 if (image_state) {
1533 skip |= core_validation::ValidateObjectNotInUse(device_data, image_state, obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001534 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001535 }
1536 return skip;
1537}
1538
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001539void PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1540 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001541 if (!image) return;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001542 IMAGE_STATE *image_state = core_validation::GetImageState(device_data, image);
1543 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001544 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001545 // Clean up memory mapping, bindings and range references for image
1546 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001547 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001548 if (mem_info) {
1549 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1550 }
1551 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001552 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001553 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001554 // Remove image from imageMap
1555 core_validation::GetImageMap(device_data)->erase(image);
1556 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1557 core_validation::GetImageSubresourceMap(device_data);
1558
1559 const auto &sub_entry = imageSubresourceMap->find(image);
1560 if (sub_entry != imageSubresourceMap->end()) {
1561 for (const auto &pair : sub_entry->second) {
1562 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1563 }
1564 imageSubresourceMap->erase(sub_entry);
1565 }
1566}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001567
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001568bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001569 bool skip = false;
1570 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1571
1572 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1573 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1574 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 -06001575 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001576 }
1577
Dave Houlton1d2022c2017-03-29 11:43:58 -06001578 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001579 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1580 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 -06001581 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001582 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001583 char const str[] = "vkCmdClearColorImage called with compressed image.";
1584 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 -06001585 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001586 }
1587
1588 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1589 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1590 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 -06001591 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001592 }
1593 return skip;
1594}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001595
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001596uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1597 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1598 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001599 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001600 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001601 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001602 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001603}
1604
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001605uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1606 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1607 uint32_t array_layer_count = range->layerCount;
1608 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1609 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001610 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001611 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001612}
1613
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001614bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001615 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1616 bool skip = false;
1617 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1618
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001619 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1620 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001621
1622 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1623 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001624 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1625 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001626 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 -06001627 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001628 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1629 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001630 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001631 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001632 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001633 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 -06001634 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001635 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1636 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001637
1638 } else {
1639 if (image_state->shared_presentable) {
1640 skip |= log_msg(
1641 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001642 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001643 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1644 string_VkImageLayout(dest_image_layout));
1645 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001646 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001647 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001648 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001649 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001650 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001651 } else {
1652 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1653 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001654 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 -06001655 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001656 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1657 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001658 }
1659 }
1660
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001661 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1662 uint32_t level = level_index + range.baseMipLevel;
1663 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1664 uint32_t layer = layer_index + range.baseArrayLayer;
1665 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001666 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001667 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001668 if (node.layout != dest_image_layout) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001669 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001670 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001671 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001672 } else {
1673 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1674 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001675 skip |=
1676 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1677 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1678 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001679 }
1680 }
1681 }
1682 }
1683
1684 return skip;
1685}
1686
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001687void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1688 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001689 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1690 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1691 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001692
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001693 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1694 uint32_t level = level_index + range.baseMipLevel;
1695 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1696 uint32_t layer = layer_index + range.baseArrayLayer;
1697 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001698 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001699 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1700 SetLayout(device_data, cb_node, image, sub, IMAGE_CMD_BUF_LAYOUT_NODE(dest_image_layout, dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001701 }
1702 }
1703 }
1704}
1705
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001706bool PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1707 const VkClearColorValue *pColor, uint32_t rangeCount,
1708 const VkImageSubresourceRange *pRanges) {
1709 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1710
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001711 bool skip = false;
1712 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001713 auto cb_node = GetCBNode(device_data, commandBuffer);
1714 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001715 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001716 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearColorImage()",
1717 "VUID-vkCmdClearColorImage-image-00003");
1718 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001719 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001720 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
1721 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1722 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
1723 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993",
1724 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001725 }
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001726 skip |= InsideRenderPass(device_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001727 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001728 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001729 skip |= ValidateCmdClearColorSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
1730 skip |= ValidateImageAttributes(device_data, image_state, pRanges[i]);
1731 skip |= VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001732 }
1733 }
1734 return skip;
1735}
1736
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001737void PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1738 const VkClearColorValue *pColor, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1739 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1740
1741 auto cb_node = GetCBNode(device_data, commandBuffer);
1742 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001743 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001744 AddCommandBufferBindingImage(device_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001745 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001746 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001747 }
1748 }
1749}
1750
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001751bool PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1752 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001753 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001754 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001755 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001756 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1757
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001758 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001759 auto cb_node = GetCBNode(device_data, commandBuffer);
1760 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001761 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001762 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1763 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001764 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001765 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001766 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001767 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1768 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001769 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1770 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001771 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001772 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001773 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001774 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001775 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001776 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001777 skip |=
1778 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001779 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001780 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1781 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001782 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001783 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1784 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001785 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 -06001786 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001787 }
1788 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001789 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001790 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001791 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 -06001792 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001793 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001794 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1795 char const str[] =
1796 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1797 "set.";
1798 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 -06001799 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001800 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001801 }
1802 return skip;
1803}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001804
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001805void PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1806 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1807 const VkImageSubresourceRange *pRanges) {
1808 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1809
1810 auto cb_node = GetCBNode(device_data, commandBuffer);
1811 auto image_state = GetImageState(device_data, image);
1812 if (cb_node && image_state) {
1813 AddCommandBufferBindingImage(device_data, cb_node, image_state);
1814 for (uint32_t i = 0; i < rangeCount; ++i) {
1815 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
1816 }
1817 }
1818}
1819
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001820// Returns true if [x, xoffset] and [y, yoffset] overlap
1821static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1822 bool result = false;
1823 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1824 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1825
1826 if (intersection_max > intersection_min) {
1827 result = true;
1828 }
1829 return result;
1830}
1831
Dave Houltonc991cc92018-03-06 11:08:51 -07001832// Returns true if source area of first copy region intersects dest area of second region
1833// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1834static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001835 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001836
Dave Houltonc991cc92018-03-06 11:08:51 -07001837 // Separate planes within a multiplane image cannot intersect
1838 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001839 return result;
1840 }
1841
Dave Houltonc991cc92018-03-06 11:08:51 -07001842 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1843 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1844 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001845 result = true;
1846 switch (type) {
1847 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001848 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001849 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001850 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001851 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001852 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001853 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001854 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001855 break;
1856 default:
1857 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1858 assert(false);
1859 }
1860 }
1861 return result;
1862}
1863
Dave Houltonfc1a4052017-04-27 14:32:45 -06001864// Returns non-zero if offset and extent exceed image extents
1865static const uint32_t x_bit = 1;
1866static const uint32_t y_bit = 2;
1867static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001868static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001869 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001870 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001871 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1872 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001873 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001874 }
1875 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1876 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001877 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001878 }
1879 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1880 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001881 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001882 }
1883 return result;
1884}
1885
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001886// Test if two VkExtent3D structs are equivalent
1887static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1888 bool result = true;
1889 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1890 (extent->depth != other_extent->depth)) {
1891 result = false;
1892 }
1893 return result;
1894}
1895
Dave Houltonee281a52017-12-08 13:51:02 -07001896// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1897// Destination image texel extents must be adjusted by block size for the dest validation checks
1898VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1899 VkExtent3D adjusted_extent = extent;
1900 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001901 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001902 adjusted_extent.width /= block_size.width;
1903 adjusted_extent.height /= block_size.height;
1904 adjusted_extent.depth /= block_size.depth;
1905 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001906 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001907 adjusted_extent.width *= block_size.width;
1908 adjusted_extent.height *= block_size.height;
1909 adjusted_extent.depth *= block_size.depth;
1910 }
1911 return adjusted_extent;
1912}
1913
Dave Houlton6f9059e2017-05-02 17:15:13 -06001914// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001915static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1916 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001917
1918 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001919 if (mip >= img->createInfo.mipLevels) {
1920 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001921 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001922
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001923 // 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 -06001924 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001925
Dave Houltone48cd112019-01-03 17:01:18 -07001926 // If multi-plane, adjust per-plane extent
1927 if (FormatIsMultiplane(img->createInfo.format)) {
1928 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1929 extent.width /= divisors.width;
1930 extent.height /= divisors.height;
1931 }
1932
Jeff Bolzef40fec2018-09-01 22:04:34 -05001933 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1934 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001935 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001936 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1937 } else {
1938 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1939 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1940 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1941 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001942
Dave Houlton6f9059e2017-05-02 17:15:13 -06001943 // Image arrays have an effective z extent that isn't diminished by mip level
1944 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001945 extent.depth = img->createInfo.arrayLayers;
1946 }
1947
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001948 return extent;
1949}
1950
1951// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001952static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001953 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1954}
1955
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001956// Test if the extent argument has any dimensions set to 0.
1957static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1958 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1959}
1960
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001961// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1962static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1963 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1964 VkExtent3D granularity = {0, 0, 0};
1965 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1966 if (pPool) {
1967 granularity =
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07001968 GetPhysicalDeviceState(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001969 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001970 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001971 granularity.width *= block_size.width;
1972 granularity.height *= block_size.height;
1973 }
1974 }
1975 return granularity;
1976}
1977
1978// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1979static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1980 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001981 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1982 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001983 valid = false;
1984 }
1985 return valid;
1986}
1987
1988// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1989static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001990 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001991 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001992 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1993 bool skip = false;
1994 VkExtent3D offset_extent = {};
1995 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1996 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1997 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001998 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001999 // 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 -07002000 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002001 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 -04002002 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002003 "%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 "
2004 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002005 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002006 }
2007 } else {
2008 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2009 // integer multiples of the image transfer granularity.
2010 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002011 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 -04002012 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002013 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2014 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002015 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2016 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002017 }
2018 }
2019 return skip;
2020}
2021
2022// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
2023static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
2024 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002025 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002026 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002027 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2028 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002029 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002030 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2031 // subresource extent.
2032 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002033 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 -04002034 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002035 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2036 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2037 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2038 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002039 }
2040 } else {
2041 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2042 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2043 // subresource extent dimensions.
2044 VkExtent3D offset_extent_sum = {};
2045 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2046 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2047 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002048 bool x_ok = true;
2049 bool y_ok = true;
2050 bool z_ok = true;
2051 switch (image_type) {
2052 case VK_IMAGE_TYPE_3D:
2053 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2054 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002055 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002056 case VK_IMAGE_TYPE_2D:
2057 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2058 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002059 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002060 case VK_IMAGE_TYPE_1D:
2061 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2062 (subresource_extent->width == offset_extent_sum.width));
2063 break;
2064 default:
2065 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2066 assert(false);
2067 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002068 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002069 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 -04002070 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002071 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2072 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2073 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2074 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2075 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2076 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002077 }
2078 }
2079 return skip;
2080}
2081
Cort Strattonff1542a2018-05-27 10:49:28 -07002082bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002083 const uint32_t i, const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002084 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2085 bool skip = false;
2086 if (mip_level >= img->createInfo.mipLevels) {
2087 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2088 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07002089 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
2090 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002091 }
2092 return skip;
2093}
2094
2095bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2096 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002097 const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002098 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2099 bool skip = false;
2100 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2101 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2102 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2103 HandleToUint64(cb_node->commandBuffer), vuid,
2104 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07002105 "%u, but provided image %s has %u array layers.",
2106 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2107 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002108 }
2109 return skip;
2110}
2111
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002112// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002113bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2114 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002115 const uint32_t i, const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002116 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002117 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2118 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2119 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2120 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2121 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002122 return skip;
2123}
2124
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002125// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002126bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002127 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2128 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002129 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002130 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002131 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002132 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2133 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002134 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002135 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002136 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002137 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002138
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002139 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002140 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002141 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2142 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002143 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002144 const VkExtent3D dest_effective_extent =
2145 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002146 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002147 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002148 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002149 return skip;
2150}
2151
Dave Houlton6f9059e2017-05-02 17:15:13 -06002152// Validate contents of a VkImageCopy struct
2153bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
2154 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
2155 bool skip = false;
2156
2157 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002158 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002159
2160 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002161 const VkExtent3D src_copy_extent = region.extent;
2162 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002163 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2164
Dave Houlton6f9059e2017-05-02 17:15:13 -06002165 bool slice_override = false;
2166 uint32_t depth_slices = 0;
2167
2168 // Special case for copying between a 1D/2D array and a 3D image
2169 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2170 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002171 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002172 slice_override = (depth_slices != 1);
2173 } 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 -07002174 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002175 slice_override = (depth_slices != 1);
2176 }
2177
2178 // Do all checks on source image
2179 //
2180 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002181 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2182 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 -06002183 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002184 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002185 "be 0 and 1, respectively.",
2186 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002187 }
2188 }
2189
Dave Houlton533be9f2018-03-26 17:08:30 -06002190 // VUID-VkImageCopy-srcImage-01785
2191 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2192 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 -06002193 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002194 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002195 "these must be 0 and 1, respectively.",
2196 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002197 }
2198
Dave Houlton533be9f2018-03-26 17:08:30 -06002199 // VUID-VkImageCopy-srcImage-01787
2200 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2201 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 -06002202 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002203 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2204 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002205 }
2206
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002207 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002208 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002209 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002210 skip |=
2211 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002212 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002213 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002214 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2215 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216 }
2217 }
2218 } else { // Pre maint 1
2219 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002220 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002221 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 -06002222 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002223 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2224 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002225 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2226 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227 }
2228 }
2229 }
2230
Dave Houltonc991cc92018-03-06 11:08:51 -07002231 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2232 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
2233 if (FormatIsCompressed(src_state->createInfo.format) ||
2234 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002235 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002236 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002237 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2238 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2239 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002240 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002241 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 -07002242 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002243 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002244 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002245 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002246 }
2247
Dave Houlton94a00372017-12-14 15:08:47 -07002248 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002249 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2250 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002251 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002252 skip |=
2253 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002254 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002256 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002257 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002258 }
2259
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002260 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002261 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2262 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002263 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002264 skip |=
2265 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002266 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002268 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002269 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 }
2271
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002272 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002273 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2274 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002275 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002276 skip |=
2277 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002278 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002279 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002280 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002281 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002282 }
2283 } // Compressed
2284
2285 // Do all checks on dest image
2286 //
2287 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002288 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002289 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 -06002290 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002291 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002292 "these must be 0 and 1, respectively.",
2293 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002294 }
2295 }
2296
Dave Houlton533be9f2018-03-26 17:08:30 -06002297 // VUID-VkImageCopy-dstImage-01786
2298 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2299 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 -06002300 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002301 "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 -06002302 "and 1, respectively.",
2303 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002304 }
2305
2306 // VUID-VkImageCopy-dstImage-01788
2307 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2308 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 -06002309 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002310 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2311 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002312 }
2313
2314 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002315 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002316 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 -06002317 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002318 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002319 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2320 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002321 }
2322 }
2323 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002324 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002325 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002326 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002327 skip |=
2328 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002329 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002330 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002331 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2332 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002333 }
2334 }
2335 } else { // Pre maint 1
2336 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002337 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002338 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 -06002339 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002340 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2341 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002342 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2343 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002344 }
2345 }
2346 }
2347
Dave Houltonc991cc92018-03-06 11:08:51 -07002348 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2349 if (FormatIsCompressed(dst_state->createInfo.format) ||
2350 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002351 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002352
2353 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002354 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2355 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2356 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002357 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002358 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 -07002359 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002360 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002361 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002362 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002363 }
2364
Dave Houlton94a00372017-12-14 15:08:47 -07002365 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002366 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2367 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002368 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002369 skip |=
2370 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002371 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002372 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002373 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002374 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002375 }
2376
Dave Houltonee281a52017-12-08 13:51:02 -07002377 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2378 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2379 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002380 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002381 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 -07002382 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002383 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2384 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002385 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002386 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002387 }
2388
Dave Houltonee281a52017-12-08 13:51:02 -07002389 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2390 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2391 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002392 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002393 skip |=
2394 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002395 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002396 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002397 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002398 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002399 }
2400 } // Compressed
2401 }
2402 return skip;
2403}
2404
Dave Houltonc991cc92018-03-06 11:08:51 -07002405// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2406bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2407 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2408 bool skip = false;
2409 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2410
2411 // Neither image is multiplane
2412 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2413 // If neither image is multi-plane the aspectMask member of src and dst must match
2414 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2415 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002416 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002417 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2418 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 -06002419 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002420 }
2421 } else {
2422 // Source image multiplane checks
2423 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2424 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2425 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2426 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002427 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002428 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 -06002429 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002430 }
2431 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2432 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2433 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002434 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002435 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 -06002436 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002437 }
2438 // Single-plane to multi-plane
2439 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2440 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2441 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002442 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002443 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 -06002444 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002445 }
2446
2447 // Dest image multiplane checks
2448 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2449 aspect = region.dstSubresource.aspectMask;
2450 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2451 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002452 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002453 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 -06002454 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002455 }
2456 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2457 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2458 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002459 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002460 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 -06002461 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002462 }
2463 // Multi-plane to single-plane
2464 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2465 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2466 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002467 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002468 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 -06002469 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002470 }
2471 }
2472
2473 return skip;
2474}
2475
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002476bool PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2477 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageCopy *pRegions) {
2478 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2479 auto cb_node = GetCBNode(device_data, commandBuffer);
2480 auto src_image_state = GetImageState(device_data, srcImage);
2481 auto dst_image_state = GetImageState(device_data, dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002482 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002483 const debug_report_data *report_data = device_data->report_data;
2484
2485 skip = ValidateImageCopyData(device_data, report_data, regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002486
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002487 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2488
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002489 for (uint32_t i = 0; i < regionCount; i++) {
2490 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002491
2492 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2493 VkExtent3D src_copy_extent = region.extent;
2494 VkExtent3D dst_copy_extent =
2495 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2496
Dave Houlton6f9059e2017-05-02 17:15:13 -06002497 bool slice_override = false;
2498 uint32_t depth_slices = 0;
2499
2500 // Special case for copying between a 1D/2D array and a 3D image
2501 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2502 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2503 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002504 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002505 slice_override = (depth_slices != 1);
2506 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2507 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002508 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002509 slice_override = (depth_slices != 1);
2510 }
2511
Cort Strattond619a302018-05-17 19:46:32 -07002512 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2513 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002514 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2515 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2516 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2517 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2518 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2519 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2520 "VUID-vkCmdCopyImage-srcSubresource-01698");
2521 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2522 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2523 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002524
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002525 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002526 // No chance of mismatch if we're overriding depth slice count
2527 if (!slice_override) {
2528 // The number of depth slices in srcSubresource and dstSubresource must match
2529 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2530 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002531 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2532 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002533 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002534 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2535 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002536 if (src_slices != dst_slices) {
2537 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002538 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002539 << "] do not match";
2540 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002541 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002542 }
2543 }
2544 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002545 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002546 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002547 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002548 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002549 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002550 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002551 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002552 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002553 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002554
Dave Houltonc991cc92018-03-06 11:08:51 -07002555 // Do multiplane-specific checks, if extension enabled
2556 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2557 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2558 }
2559
Dave Houltonf5217612018-02-02 16:18:52 -07002560 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2561 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2562 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002563 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002564 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-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002566 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002567 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002568
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002569 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002570 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002571 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002572 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002573 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2574 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 -06002575 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002576 }
2577
2578 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002579 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002580 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002581 ss << "vkCmdCopyImage(): pRegion[" << i
2582 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002583 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 -06002584 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002585 }
2586
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002587 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2588 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2589 // 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 -07002590 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2591 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002592 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002593 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002594 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2595 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2596 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002597 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002598 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002599 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002600
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002601 // 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 -07002602 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2603 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002604 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002605 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002606 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2607 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2608 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002609 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 -06002610 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002611 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002612 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002613
Dave Houltonfc1a4052017-04-27 14:32:45 -06002614 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002615 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2616 if (slice_override) src_copy_extent.depth = depth_slices;
2617 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002618 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002619 skip |=
2620 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2621 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2622 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2623 "width [%1d].",
2624 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002625 }
2626
2627 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002628 skip |=
2629 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2630 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2631 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2632 "height [%1d].",
2633 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002634 }
2635 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002636 skip |=
2637 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2638 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2639 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2640 "depth [%1d].",
2641 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002642 }
2643
Dave Houltonee281a52017-12-08 13:51:02 -07002644 // Adjust dest extent if necessary
2645 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2646 if (slice_override) dst_copy_extent.depth = depth_slices;
2647
2648 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002649 if (extent_check & x_bit) {
2650 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 -06002651 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002652 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002653 "width [%1d].",
2654 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002655 }
2656 if (extent_check & y_bit) {
2657 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 -06002658 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002659 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002660 "height [%1d].",
2661 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002662 }
2663 if (extent_check & z_bit) {
2664 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 -06002665 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002666 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002667 "depth [%1d].",
2668 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002669 }
2670
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002671 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2672 // must not overlap in memory
2673 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002674 for (uint32_t j = 0; j < regionCount; j++) {
2675 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002676 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002677 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002678 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002679 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 -06002680 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002681 }
2682 }
2683 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002684 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002685
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002686 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2687 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2688 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002689 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002690 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2691 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002692 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 -06002693 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002694 }
2695 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002696 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002697 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2698 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 -06002699 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002700 }
2701 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002702
Dave Houlton33c22b72017-02-28 13:16:02 -07002703 // Source and dest image sample counts must match
2704 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2705 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2706 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 -06002707 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002708 }
2709
Dave Houltond8ed0212018-05-16 17:18:24 -06002710 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2711 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002712 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002713 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2714 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2715 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2716 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002717 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002718 skip |=
2719 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002720 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002721 skip |=
2722 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002723 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002724 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002725 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002726 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2727 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002728 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002729 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002730 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002731 const char *invalid_src_layout_vuid =
Cort Stratton7df30962018-05-17 19:45:57 -07002732 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2733 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2734 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002735 const char *invalid_dst_layout_vuid =
Cort Stratton7df30962018-05-17 19:45:57 -07002736 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2737 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2738 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002739 for (uint32_t i = 0; i < regionCount; ++i) {
2740 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002741 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2742 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002743 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002744 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2745 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002746 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002747 &pRegions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002748 }
2749
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002750 return skip;
2751}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002752
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002753void PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2754 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageCopy *pRegions) {
2755 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2756 auto cb_node = GetCBNode(device_data, commandBuffer);
2757 auto src_image_state = GetImageState(device_data, srcImage);
2758 auto dst_image_state = GetImageState(device_data, dstImage);
2759
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002760 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002761 for (uint32_t i = 0; i < regionCount; ++i) {
2762 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2763 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002764 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002765 // Update bindings between images and cmd buffer
2766 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2767 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002768}
2769
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002770// Returns true if sub_rect is entirely contained within rect
2771static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2772 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2773 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2774 return false;
2775 return true;
2776}
2777
John Zulauf3a548ef2019-02-01 16:14:07 -07002778static bool ValidateClearAttachementExtent(const layer_data *device_data, VkCommandBuffer command_buffer, uint32_t attachment_index,
2779 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2780 uint32_t rect_count, const VkClearRect *clear_rects) {
2781 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002782 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2783 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
2784 image_view_state = GetImageViewState(device_data, framebuffer->createInfo.pAttachments[fb_attachment]);
2785 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002786
2787 for (uint32_t j = 0; j < rect_count; j++) {
2788 if (!ContainsRect(render_area, clear_rects[j].rect)) {
2789 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2790 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2791 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2792 "the current render pass instance.",
2793 j);
2794 }
2795
2796 if (image_view_state) {
2797 // The layers specified by a given element of pRects must be contained within every attachment that
2798 // pAttachments refers to
2799 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2800 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2801 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
2802 skip |=
2803 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2804 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2805 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2806 "of pAttachment[%d].",
2807 j, attachment_index);
2808 }
2809 }
2810 }
2811 return skip;
2812}
2813
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002814bool PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002815 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002816 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2817
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002818 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002819 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002820
2821 bool skip = false;
2822 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002823 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002824 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002825 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002826 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002827 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002828 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2829 // 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 -07002830 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2831 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002832 skip |=
2833 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2834 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2835 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2836 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2837 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002838 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002839 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002840 }
2841
2842 // Validate that attachment is in reference list of active subpass
2843 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002844 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002845 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002846 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002847 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002848 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2849 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002850
John Zulauf3a548ef2019-02-01 16:14:07 -07002851 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2852 auto clear_desc = &pAttachments[attachment_index];
2853 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002854
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002855 if (0 == clear_desc->aspectMask) {
2856 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 -06002857 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002858 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2859 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 -06002860 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002861 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002862 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2863 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2864 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2865 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002866 skip |= log_msg(
2867 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2868 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2869 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2870 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2871 attachment_index, clear_desc->colorAttachment,
2872 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2873 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2874
John Zulauff2582972019-02-09 14:53:30 -07002875 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2876 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002877 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002878 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2879 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2880 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2881 " subpass %u. colorAttachmentCount=%u",
2882 attachment_index, clear_desc->colorAttachment,
2883 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2884 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002885 }
John Zulauff2582972019-02-09 14:53:30 -07002886 fb_attachment = color_attachment;
2887
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002888 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2889 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2890 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002891 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002892 skip |=
2893 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2894 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002895 }
2896 } else { // Must be depth and/or stencil
2897 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2898 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002899 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002900 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 -07002901 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2902 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002903 }
2904 if (!subpass_desc->pDepthStencilAttachment ||
2905 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2906 skip |= log_msg(
2907 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002908 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002909 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002910 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002911 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002912 }
2913 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002914 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2915 skip |= ValidateClearAttachementExtent(device_data, commandBuffer, attachment_index, framebuffer, fb_attachment,
2916 render_area, rectCount, pRects);
2917 } else {
2918 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2919 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2920 if (!clear_rect_copy) {
2921 // We need a copy of the clear rectangles that will persist until the last lambda executes
2922 // but we want to create it as lazily as possible
2923 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002924 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002925
2926 auto val_fn = [device_data, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
2927 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2928 assert(rectCount == clear_rect_copy->size());
2929 auto framebuffer = GetFramebufferState(device_data, fb);
2930 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2931 bool skip = false;
2932 skip = ValidateClearAttachementExtent(device_data, commandBuffer, attachment_index, framebuffer, fb_attachment,
2933 render_area, rectCount, clear_rect_copy->data());
2934 return skip;
2935 };
2936 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002937 }
2938 }
2939 }
2940 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002941}
2942
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002943bool PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2944 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageResolve *pRegions) {
2945 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2946 auto cb_node = GetCBNode(device_data, commandBuffer);
2947 auto src_image_state = GetImageState(device_data, srcImage);
2948 auto dst_image_state = GetImageState(device_data, dstImage);
2949
2950 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002951 bool skip = false;
2952 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002953 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2954 "VUID-vkCmdResolveImage-srcImage-00256");
2955 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2956 "VUID-vkCmdResolveImage-dstImage-00258");
2957 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2958 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002959 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002960 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002961 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002962 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2963 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002964
Cort Stratton7df30962018-05-17 19:45:57 -07002965 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002966 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable &&
2967 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2968 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2969 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2970 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable &&
2971 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2972 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2973 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002974 // For each region, the number of layers in the image subresource should not be zero
2975 // For each region, src and dest image aspect must be color only
2976 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002977 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2978 "srcSubresource", i);
2979 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2980 "dstSubresource", i);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002981 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002982 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2983 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002984 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002985 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2986 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002987 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2988 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2989 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2990 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2991 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2992 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2993 "VUID-vkCmdResolveImage-srcSubresource-01711");
2994 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2995 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2996 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002997
2998 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002999 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3000 skip |= log_msg(
3001 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003002 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003003 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003004 }
Cort Stratton7df30962018-05-17 19:45:57 -07003005 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003006 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3007 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3008 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003009 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003010 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003011 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003012 }
3013 }
3014
3015 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3016 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003017 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 -06003018 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003019 }
3020 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3021 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003022 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 -06003023 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003024 }
3025 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3026 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3027 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 -06003028 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003029 }
3030 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3031 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3032 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 -06003033 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003034 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003035 } else {
3036 assert(0);
3037 }
3038 return skip;
3039}
3040
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003041void PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
3042 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageResolve *pRegions) {
3043 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
3044 auto cb_node = GetCBNode(device_data, commandBuffer);
3045 auto src_image_state = GetImageState(device_data, srcImage);
3046 auto dst_image_state = GetImageState(device_data, dstImage);
3047
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003048 // Update bindings between images and cmd buffer
3049 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3050 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003051}
3052
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003053bool PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
3054 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3055 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
3056 auto cb_node = GetCBNode(device_data, commandBuffer);
3057 auto src_image_state = GetImageState(device_data, srcImage);
3058 auto dst_image_state = GetImageState(device_data, dstImage);
3059 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003060
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003061 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003062 if (cb_node) {
3063 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3064 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003065 if (cb_node && src_image_state && dst_image_state) {
3066 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003067 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003068 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003069 "VUID-vkCmdBlitImage-dstImage-00234");
3070 skip |=
3071 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3072 skip |=
3073 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
3074 skip |=
3075 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
3076 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3077 skip |=
3078 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
3079 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3080 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
3081 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003082 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003083 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04003084 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003085 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04003086 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003087 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003088
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003089 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003090
Dave Houlton33c2d252017-06-09 17:08:32 -06003091 VkFormat src_format = src_image_state->createInfo.format;
3092 VkFormat dst_format = dst_image_state->createInfo.format;
3093 VkImageType src_type = src_image_state->createInfo.imageType;
3094 VkImageType dst_type = dst_image_state->createInfo.imageType;
3095
Cort Stratton186b1a22018-05-01 20:18:06 -04003096 if (VK_FILTER_LINEAR == filter) {
3097 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003098 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3099 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003100 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003101 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
3102 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003103 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003104 }
3105
3106 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3107 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 -06003108 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003109 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003110 }
3111
Dave Houlton33c2d252017-06-09 17:08:32 -06003112 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3113 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3114 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003115 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003116 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003117 }
3118
3119 // Validate consistency for unsigned formats
3120 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3121 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003122 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003123 << "the other one must also have unsigned integer format. "
3124 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3125 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 -06003126 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003127 }
3128
3129 // Validate consistency for signed formats
3130 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3131 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003132 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003133 << "the other one must also have signed integer format. "
3134 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3135 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 -06003136 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003137 }
3138
3139 // Validate filter for Depth/Stencil formats
3140 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3141 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003142 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003143 << "then filter must be VK_FILTER_NEAREST.";
3144 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003145 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003146 }
3147
3148 // Validate aspect bits and formats for depth/stencil images
3149 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3150 if (src_format != dst_format) {
3151 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003152 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003153 << "stencil, the other one must have exactly the same format. "
3154 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3155 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003156 skip |=
3157 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3158 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003159 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003160 } // Depth or Stencil
3161
3162 // Do per-region checks
Jeff Bolzfdd0d852019-02-03 21:55:12 -06003163 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable &&
3164 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3165 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3166 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3167 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable &&
3168 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3169 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3170 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003171 for (uint32_t i = 0; i < regionCount; i++) {
3172 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003173 bool hit_error = false;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003174 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003175 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3176 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003177 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003178 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3179 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003180 skip |=
3181 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3182 skip |=
3183 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003184 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3185 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3186 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3187 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3188 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3189 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3190 "VUID-vkCmdBlitImage-srcSubresource-01707");
3191 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3192 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3193 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003194 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003195 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3196 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003197 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003198 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003199 skip |=
3200 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3201 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003202 }
Dave Houlton48989f32017-05-26 15:01:46 -06003203 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3204 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003205 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003206 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003207 skip |=
3208 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3209 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003210 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003211
3212 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003213 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003214 skip |= log_msg(
3215 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3216 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3217 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003218 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003219
Dave Houlton48989f32017-05-26 15:01:46 -06003220 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003221 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 -06003222 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003223 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003224 }
Dave Houlton48989f32017-05-26 15:01:46 -06003225
Dave Houlton33c2d252017-06-09 17:08:32 -06003226 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3227 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 -06003228 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003229 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003230 "image format %s.",
3231 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003232 }
3233
3234 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3235 skip |= log_msg(
3236 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003237 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003238 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3239 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003240 }
3241
Dave Houlton48989f32017-05-26 15:01:46 -06003242 // Validate source image offsets
3243 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003244 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003245 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003246 skip |=
3247 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3248 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3249 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3250 "of (%1d, %1d). These must be (0, 1).",
3251 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003252 }
3253 }
3254
Dave Houlton33c2d252017-06-09 17:08:32 -06003255 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003256 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3257 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 -06003258 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003259 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003260 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3261 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003262 }
3263 }
3264
Dave Houlton33c2d252017-06-09 17:08:32 -06003265 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003266 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3267 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003268 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003269 skip |= log_msg(
3270 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3271 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3272 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3273 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003274 }
3275 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3276 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003277 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003278 skip |= log_msg(
3279 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003280 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003281 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003282 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003283 }
3284 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3285 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003286 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003287 skip |= log_msg(
3288 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3289 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3290 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3291 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003292 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003293 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003294 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 -06003295 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003296 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003297 }
Dave Houlton48989f32017-05-26 15:01:46 -06003298
3299 // Validate dest image offsets
3300 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003301 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003302 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003303 skip |=
3304 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3305 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3306 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3307 "(%1d, %1d). These must be (0, 1).",
3308 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003309 }
3310 }
3311
Dave Houlton33c2d252017-06-09 17:08:32 -06003312 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003313 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3314 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 -06003315 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003316 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003317 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3318 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003319 }
3320 }
3321
Dave Houlton33c2d252017-06-09 17:08:32 -06003322 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003323 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3324 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003325 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003326 skip |= log_msg(
3327 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3328 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3329 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3330 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003331 }
3332 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3333 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003334 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003335 skip |= log_msg(
3336 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003337 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003338 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003339 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003340 }
3341 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3342 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003343 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003344 skip |= log_msg(
3345 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3346 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3347 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3348 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003349 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003350 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003351 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 -06003352 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003353 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003354 }
3355
Dave Houlton33c2d252017-06-09 17:08:32 -06003356 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3357 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3358 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003359 skip |=
3360 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3361 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3362 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3363 "layerCount other than 1.",
3364 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003365 }
3366 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003367 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003368 } else {
3369 assert(0);
3370 }
3371 return skip;
3372}
3373
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003374void PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
3375 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3376 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
3377 auto cb_node = GetCBNode(device_data, commandBuffer);
3378 auto src_image_state = GetImageState(device_data, srcImage);
3379 auto dst_image_state = GetImageState(device_data, dstImage);
3380
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003381 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003382 for (uint32_t i = 0; i < regionCount; ++i) {
3383 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3384 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003385 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003386 // Update bindings between images and cmd buffer
3387 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3388 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003389}
3390
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003391// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07003392bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003393 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3394 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003395 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07003396 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003397 for (auto cb_image_data : pCB->imageLayoutMap) {
3398 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003399
Dave Houltonb3f4b282018-02-22 16:25:16 -07003400 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3401 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003402 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3403 // TODO: Set memory invalid which is in mem_tracker currently
3404 } else if (imageLayout != cb_image_data.second.initialLayout) {
3405 if (cb_image_data.first.hasSubresource) {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003406 skip |=
3407 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3408 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07003409 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, mip level "
3410 "%u) to be in layout %s--instead, image %s's current layout is %s.",
3411 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3412 cb_image_data.first.subresource.aspectMask, cb_image_data.first.subresource.arrayLayer,
3413 cb_image_data.first.subresource.mipLevel, string_VkImageLayout(cb_image_data.second.initialLayout),
3414 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
3415 } else {
3416 skip |= log_msg(
3417 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3418 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3419 "Submitted command buffer expects image %s to be in layout %s--instead, image %s's current layout is %s.",
3420 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3421 string_VkImageLayout(cb_image_data.second.initialLayout),
3422 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003423 }
3424 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003425 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003426 }
3427 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003428 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003429}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003430
Tony Barbourdf013b92017-01-25 12:53:48 -07003431void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
3432 for (auto cb_image_data : pCB->imageLayoutMap) {
3433 VkImageLayout imageLayout;
3434 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3435 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3436 }
3437}
3438
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003439// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003440// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3441// layout attachments don't have CLEAR as their loadOp.
Tobias Hectorbbb12282018-10-22 15:17:59 +01003442bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3443 const VkImageLayout first_layout, const uint32_t attachment,
3444 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003445 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003446 const char *vuid;
3447 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3448
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003449 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3450 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003451 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3452 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3453 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003454 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003455 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3456 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3457 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3458 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3459 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3460 skip |=
3461 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3462 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003463 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003464 }
3465 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003466 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3467 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003468 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003469 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003470 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 -06003471 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003472 }
3473 }
3474
3475 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3476 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003477 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003478 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003479 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 -06003480 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003481 }
3482 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003483 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003484}
3485
Tobias Hectorbbb12282018-10-22 15:17:59 +01003486bool ValidateLayouts(const core_validation::layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3487 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003488 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003489 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003490 const char *vuid;
3491 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3492 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003493
Jason Ekstranda1906302017-12-03 20:16:32 -08003494 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3495 VkFormat format = pCreateInfo->pAttachments[i].format;
3496 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3497 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3498 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003499 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 -06003500 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003501 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3502 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3503 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3504 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003505 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003506 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003507 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 -06003508 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003509 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3510 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3511 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3512 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003513 }
3514 }
3515 }
3516
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003517 // Track when we're observing the first use of an attachment
3518 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3519 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003520 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003521
3522 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3523 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3524 auto attach_index = subpass.pInputAttachments[j].attachment;
3525 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003526 switch (subpass.pInputAttachments[j].layout) {
3527 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3528 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3529 // These are ideal.
3530 break;
3531
3532 case VK_IMAGE_LAYOUT_GENERAL:
3533 // May not be optimal. TODO: reconsider this warning based on other constraints.
3534 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003535 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003536 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3537 break;
3538
Tobias Hectorbbb12282018-10-22 15:17:59 +01003539 case VK_IMAGE_LAYOUT_UNDEFINED:
3540 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3541 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3542 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3543 "Layout for input attachment reference %u in subpass %u is %s but must be "
3544 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3545 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3546 break;
3547
Graeme Leese668a9862018-10-08 10:40:02 +01003548 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3549 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3550 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3551 break;
3552 } else {
3553 // Intentionally fall through to generic error message
3554 }
3555 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003556
Cort Stratton7547f772017-05-04 15:18:52 -07003557 default:
3558 // No other layouts are acceptable
3559 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 -06003560 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003561 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3562 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3563 }
3564
Cort Stratton7547f772017-05-04 15:18:52 -07003565 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003566 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3567 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003568
3569 bool used_as_depth =
3570 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3571 bool used_as_color = false;
3572 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3573 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3574 }
3575 if (!used_as_depth && !used_as_color &&
3576 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003577 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3578 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3579 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3580 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003581 }
3582 }
3583 attach_first_use[attach_index] = false;
3584 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003585
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003586 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3587 auto attach_index = subpass.pColorAttachments[j].attachment;
3588 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3589
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003590 // TODO: Need a way to validate shared presentable images here, currently just allowing
3591 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3592 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003593 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003594 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003595 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003596 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3597 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003598 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003599
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003600 case VK_IMAGE_LAYOUT_GENERAL:
3601 // May not be optimal; TODO: reconsider this warning based on other constraints?
3602 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003603 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003604 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3605 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003606
Tobias Hectorbbb12282018-10-22 15:17:59 +01003607 case VK_IMAGE_LAYOUT_UNDEFINED:
3608 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3609 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3610 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3611 "Layout for color attachment reference %u in subpass %u is %s but should be "
3612 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3613 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3614 break;
3615
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003616 default:
3617 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 -06003618 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003619 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3620 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003621 }
3622
John Zulauf4eee2692019-02-09 16:14:25 -07003623 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3624 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3625 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003626 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3627 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 -07003628 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003629 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003630 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003631 }
3632
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003633 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003634 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3635 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003636 }
3637 attach_first_use[attach_index] = false;
3638 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003639
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003640 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3641 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003642 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3643 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3644 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003645 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003646
Dave Houltona9df0ce2018-02-07 10:51:23 -07003647 case VK_IMAGE_LAYOUT_GENERAL:
3648 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3649 // doing a bunch of transitions.
3650 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003651 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003652 "GENERAL layout for depth attachment may not give optimal performance.");
3653 break;
3654
Tobias Hectorbbb12282018-10-22 15:17:59 +01003655 case VK_IMAGE_LAYOUT_UNDEFINED:
3656 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3657 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3658 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3659 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3660 "layout or GENERAL.",
3661 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3662 break;
3663
Dave Houltona9df0ce2018-02-07 10:51:23 -07003664 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3665 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3666 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3667 break;
3668 } else {
3669 // Intentionally fall through to generic error message
3670 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003671 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003672
Dave Houltona9df0ce2018-02-07 10:51:23 -07003673 default:
3674 // No other layouts are acceptable
3675 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 -06003676 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003677 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3678 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3679 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003680 }
3681
3682 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3683 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003684 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3685 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003686 }
3687 attach_first_use[attach_index] = false;
3688 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003689 }
3690 return skip;
3691}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003692
3693// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003694bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3695 VkDeviceSize offset, VkDeviceSize end_offset) {
3696 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3697 bool skip = false;
3698 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3699 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003700 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3701 for (auto image_handle : mem_info->bound_images) {
3702 auto img_it = mem_info->bound_ranges.find(image_handle);
3703 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003704 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003705 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003706 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003707 for (auto layout : layouts) {
3708 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003709 skip |=
3710 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 -06003711 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003712 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3713 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003714 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003715 }
3716 }
3717 }
3718 }
3719 }
3720 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003721 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003722}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003723
3724// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3725// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003726static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
Jeff Bolzfdd0d852019-02-03 21:55:12 -06003727 VulkanObjectType obj_type, const char *msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003728 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003729
3730 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003731 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003732 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003733 if (strict) {
3734 correct_usage = ((actual & desired) == desired);
3735 } else {
3736 correct_usage = ((actual & desired) != 0);
3737 }
3738 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003739 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003740 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003741 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3742 kVUID_Core_MemTrack_InvalidUsageFlag,
3743 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3744 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003745 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003746 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3747 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3748 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003749 }
3750 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003751 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003752}
3753
3754// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3755// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003756bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Jeff Bolzfdd0d852019-02-03 21:55:12 -06003757 const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003758 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3759 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003760}
3761
Cort Stratton186b1a22018-05-01 20:18:06 -04003762bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06003763 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003764 VkFormatProperties format_properties = GetPDFormatProperties(dev_data, image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003765 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3766 bool skip = false;
3767 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3768 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003769 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3770 HandleToUint64(image_state->image), linear_vuid,
3771 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3772 format_properties.linearTilingFeatures, image_state->createInfo.format,
3773 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003774 }
3775 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3776 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3777 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3778 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003779 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003780 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003781 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003782 }
3783 }
3784 return skip;
3785}
3786
Cort Strattond619a302018-05-17 19:46:32 -07003787bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3788 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3789 uint32_t i) {
3790 bool skip = false;
3791 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3792 // layerCount must not be zero
3793 if (subresource_layers->layerCount == 0) {
3794 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3795 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3796 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3797 }
3798 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3799 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3801 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3802 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3803 }
3804 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3805 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3806 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3807 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3808 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3809 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3810 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3811 func_name, i, member);
3812 }
3813 return skip;
3814}
3815
Mark Lobodzinski96210742017-02-09 10:33:46 -07003816// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3817// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003818bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Jeff Bolzfdd0d852019-02-03 21:55:12 -06003819 const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003820 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3821 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003822}
3823
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003824bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3825 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3826 bool skip = false;
3827 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3828
3829 const VkDeviceSize &range = pCreateInfo->range;
3830 if (range != VK_WHOLE_SIZE) {
3831 // Range must be greater than 0
3832 if (range <= 0) {
3833 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3834 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3835 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3836 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3837 range);
3838 }
3839 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003840 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003841 if (range % format_size != 0) {
3842 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3843 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3844 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3845 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3846 "(" PRINTF_SIZE_T_SPECIFIER ").",
3847 range, format_size);
3848 }
3849 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3850 if (range / format_size > device_limits->maxTexelBufferElements) {
3851 skip |=
3852 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3853 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3854 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3855 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3856 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3857 range, format_size, device_limits->maxTexelBufferElements);
3858 }
3859 // The sum of range and offset must be less than or equal to the size of buffer
3860 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3861 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3862 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3863 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3864 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3865 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3866 range, pCreateInfo->offset, buffer_state->createInfo.size);
3867 }
3868 }
3869 return skip;
3870}
3871
Shannon McPherson265383a2018-06-21 15:37:52 -06003872bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3873 const VkBufferViewCreateInfo *pCreateInfo) {
3874 bool skip = false;
3875 const debug_report_data *report_data = GetReportData(device_data);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003876 const VkFormatProperties format_properties = GetPDFormatProperties(device_data, pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003877 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3878 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3879 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3880 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3881 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3882 "be supported for uniform texel buffers");
3883 }
3884 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3885 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3886 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3887 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3888 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3889 "be supported for storage texel buffers");
3890 }
3891 return skip;
3892}
3893
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003894bool PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
3895 VkBuffer *pBuffer) {
3896 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3897
Mark Lobodzinski96210742017-02-09 10:33:46 -07003898 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003899 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003900
Dave Houltond8ed0212018-05-16 17:18:24 -06003901 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003902
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003903 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003904 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 -06003905 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003906 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003907 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003908 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003909
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003910 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3911 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003912 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 -06003913 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003914 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003915 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003916 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003917
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003918 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3919 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003920 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 -06003921 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003922 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003923 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003924 }
Jeff Bolz87697532019-01-11 22:54:00 -06003925
3926 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3927 if (chained_devaddr_struct) {
3928 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3929 chained_devaddr_struct->deviceAddress != 0) {
3930 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3931 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3932 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3933 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3934 }
3935 }
3936
3937 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3938 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddressCaptureReplay) {
3939 skip |= log_msg(
3940 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3941 "VUID-VkBufferCreateInfo-flags-02605",
3942 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3943 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3944 }
3945
3946 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
3947 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddress) {
3948 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3949 "VUID-VkBufferCreateInfo-usage-02606",
3950 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3951 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3952 }
3953
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003954 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
3955 skip |= core_validation::ValidateQueueFamilies(
3956 device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3957 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3958 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
3959 }
3960
Mark Lobodzinski96210742017-02-09 10:33:46 -07003961 return skip;
3962}
3963
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003964void PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003965 VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003966 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003967 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003968 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3969 GetBufferMap(device_data)
3970 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3971}
3972
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003973bool PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3974 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
3975 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3976
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003977 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003978 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003979 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003980 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3981 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003982 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3983 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003984 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3985 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003986 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3987 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3988 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3989 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003990
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003991 // Buffer view offset must be less than the size of buffer
3992 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3993 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3994 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3995 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3996 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3997 pCreateInfo->offset, buffer_state->createInfo.size);
3998 }
3999
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07004000 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06004001 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4002 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
4003 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4004 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
4005 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4006 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4007 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4008 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004009
4010 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004011
4012 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004013 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004014 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004015}
4016
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004017void PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004018 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004019 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004020 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004021 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
4022}
Mark Lobodzinski602de982017-02-09 11:01:33 -07004023
4024// For the given format verify that the aspect masks make sense
Tobias Hectorbbb12282018-10-22 15:17:59 +01004025bool ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
4026 const char *func_name, const char *vuid) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004027 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004028 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004029 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4030 if (image != VK_NULL_HANDLE) {
4031 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4032 }
4033
Dave Houlton1d2022c2017-03-29 11:43:58 -06004034 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004035 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004036 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004037 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004038 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004039 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004040 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004041 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004042 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004043 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004044 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004045 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004046 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4047 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004048 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004049 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004050 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004051 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4052 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004053 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004054 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004055 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004056 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004057 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004058 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004059 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004060 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004061 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004062 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004063 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004064 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004065 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004066 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004067 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004068 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004069 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004070 } else if (FormatIsMultiplane(format)) {
4071 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4072 if (3 == FormatPlaneCount(format)) {
4073 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4074 }
4075 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004076 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004077 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4078 "set, where n = [0, 1, 2].",
4079 func_name);
4080 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004081 }
4082 return skip;
4083}
4084
Petr Krausffa94af2017-08-08 21:46:02 +02004085struct SubresourceRangeErrorCodes {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004086 const char *base_mip_err, *mip_count_err, *base_layer_err, *layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02004087};
4088
4089bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
4090 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
4091 const char *image_layer_count_var_name, const uint64_t image_handle,
4092 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004093 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4094 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004095
4096 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004097 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004098 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 -06004099 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004100 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004101 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4102 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004103 }
Petr Kraus4d718682017-05-18 03:38:41 +02004104
Petr Krausffa94af2017-08-08 21:46:02 +02004105 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4106 if (subresourceRange.levelCount == 0) {
4107 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 -06004108 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004109 } else {
4110 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004111
Petr Krausffa94af2017-08-08 21:46:02 +02004112 if (necessary_mip_count > image_mip_count) {
4113 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 -06004114 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004115 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004116 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004117 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004118 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004119 }
Petr Kraus4d718682017-05-18 03:38:41 +02004120 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004121 }
Petr Kraus4d718682017-05-18 03:38:41 +02004122
4123 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004124 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004125 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 -06004126 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004127 "%s: %s.baseArrayLayer (= %" PRIu32
4128 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4129 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004130 }
Petr Kraus4d718682017-05-18 03:38:41 +02004131
Petr Krausffa94af2017-08-08 21:46:02 +02004132 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4133 if (subresourceRange.layerCount == 0) {
4134 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 -06004135 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004136 } else {
4137 const uint64_t necessary_layer_count =
4138 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004139
Petr Krausffa94af2017-08-08 21:46:02 +02004140 if (necessary_layer_count > image_layer_count) {
4141 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 -06004142 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004143 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004144 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004145 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004146 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004147 }
Petr Kraus4d718682017-05-18 03:38:41 +02004148 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004149 }
Petr Kraus4d718682017-05-18 03:38:41 +02004150
Mark Lobodzinski602de982017-02-09 11:01:33 -07004151 return skip;
4152}
4153
Petr Krausffa94af2017-08-08 21:46:02 +02004154bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4155 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
4156 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
4157 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4158 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4159 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4160
4161 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4162 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4163
4164 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004165 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4166 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4167 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4168 : "VUID-VkImageViewCreateInfo-image-01482")
4169 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4170 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4171 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4172 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4173 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004174
4175 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4176 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4177 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4178}
4179
4180bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4181 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4182 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004183 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4184 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4185 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4186 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004187
4188 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4189 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4190 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4191}
4192
4193bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4194 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4195 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004196 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4197 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4198 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4199 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004200
4201 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4202 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4203 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4204}
4205
4206bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4207 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4208 const char *param_name) {
4209 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004210 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4211 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4212 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4213 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004214
4215 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4216 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4217 subresourceRangeErrorCodes);
4218}
4219
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004220bool PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4221 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
4222 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4223 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004224 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004225 IMAGE_STATE *image_state = GetImageState(device_data, pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004226 if (image_state) {
4227 skip |= ValidateImageUsageFlags(
4228 device_data, image_state,
4229 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004230 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4231 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004232 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004233 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004234 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004235 skip |=
4236 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004237 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004238 skip |= ValidateCreateImageViewSubresourceRange(
4239 device_data, image_state,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004240 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4241 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004242
4243 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4244 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004245 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4246 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004247 VkFormat view_format = pCreateInfo->format;
4248 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004249 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004250 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004251
Dave Houltonbd2e2622018-04-10 16:41:14 -06004252 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004253 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004254 if (chained_ivuci_struct) {
4255 if (chained_ivuci_struct->usage & ~image_usage) {
4256 std::stringstream ss;
4257 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004258 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004259 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004260 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 -07004261 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004262 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004263 }
4264
4265 image_usage = chained_ivuci_struct->usage;
4266 }
4267
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004268 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4269 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004270 if (FormatIsMultiplane(image_format)) {
4271 // View format must match the multiplane compatible format
4272 uint32_t plane = 3; // invalid
4273 switch (aspect_mask) {
4274 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4275 plane = 0;
4276 break;
4277 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4278 plane = 1;
4279 break;
4280 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4281 plane = 2;
4282 break;
4283 default:
4284 break;
4285 }
4286
4287 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4288 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004289 std::stringstream ss;
4290 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004291 << " is not compatible with plane " << plane << " of underlying image format "
4292 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004293 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 -07004294 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004295 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004296 }
4297 } else {
4298 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
4299 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4300 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4301 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4302 std::stringstream ss;
4303 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004304 << " is not in the same format compatibility class as image ("
4305 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004306 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4307 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004308 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004309 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004310 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004311 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004312 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004313 }
4314 } else {
4315 // Format MUST be IDENTICAL to the format the image was created with
4316 if (image_format != view_format) {
4317 std::stringstream ss;
4318 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004319 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004320 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004321 skip |=
4322 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-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004324 }
4325 }
4326
4327 // Validate correct image aspect bits for desired formats and format consistency
4328 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004329
4330 switch (image_type) {
4331 case VK_IMAGE_TYPE_1D:
4332 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004333 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 -07004334 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004335 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4336 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004337 }
4338 break;
4339 case VK_IMAGE_TYPE_2D:
4340 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4341 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4342 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004343 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-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004345 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4346 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004347 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004348 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 -07004349 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004350 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4351 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004352 }
4353 }
4354 break;
4355 case VK_IMAGE_TYPE_3D:
4356 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4357 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4358 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4359 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004360 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004361 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004362 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004363 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4364 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004365 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4366 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004367 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004368 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004369 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004370 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4371 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004372 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4373 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004374 }
4375 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004376 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 -07004377 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004378 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4379 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004380 }
4381 }
4382 } else {
4383 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004384 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 -07004385 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004386 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4387 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004388 }
4389 }
4390 break;
4391 default:
4392 break;
4393 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004394
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004395 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
4396 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004397 skip |= ValidateCreateImageViewANDROID(device_data, pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004398 }
4399
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004400 VkFormatProperties format_properties = GetPDFormatProperties(device_data, view_format);
4401 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4402 : format_properties.optimalTilingFeatures;
4403
4404 if (tiling_features == 0) {
4405 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 -07004406 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004407 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4408 "physical device.",
4409 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4410 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4411 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 -07004412 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004413 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4414 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4415 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4416 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4417 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 -07004418 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004419 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4420 "VK_IMAGE_USAGE_STORAGE_BIT.",
4421 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4422 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4423 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4424 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 -07004425 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004426 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4427 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4428 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4429 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4430 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4431 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 -07004432 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004433 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4434 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4435 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004436 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004437
Jeff Bolz9af91c52018-09-01 21:53:57 -05004438 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4439 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4440 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 -07004441 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004442 "vkCreateImageView() If image was created with usage containing "
4443 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4444 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4445 }
4446 if (view_format != VK_FORMAT_R8_UINT) {
4447 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 -07004448 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004449 "vkCreateImageView() If image was created with usage containing "
4450 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4451 }
4452 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004453 }
4454 return skip;
4455}
4456
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004457void PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004458 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004459 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004460 if (result != VK_SUCCESS) return;
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004461 auto image_view_map = GetImageViewMap(device_data);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004462 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004463
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004464 auto image_state = GetImageState(device_data, pCreateInfo->image);
4465 auto &sub_res_range = (*image_view_map)[*pView].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004466 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4467 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004468}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004469
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004470bool PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
4471 const VkBufferCopy *pRegions) {
4472 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4473 auto cb_node = GetCBNode(device_data, commandBuffer);
4474 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
4475 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4476
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004477 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004478 skip |=
4479 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4480 skip |=
4481 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004482 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004483 skip |=
4484 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4485 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4486 skip |=
4487 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4488 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004489 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004490 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4491 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004492 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004493 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004494 return skip;
4495}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004496
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004497void PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
4498 const VkBufferCopy *pRegions) {
4499 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4500 auto cb_node = GetCBNode(device_data, commandBuffer);
4501 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
4502 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4503
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004504 // Update bindings between buffers and cmd buffer
4505 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4506 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004507}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004508
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004509static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004510 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4511 bool skip = false;
4512 auto buffer_state = GetBufferState(device_data, buffer);
4513 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004514 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 -07004515 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4516 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004517 } else {
4518 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004519 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 -06004520 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004521 "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 -07004522 }
4523 }
4524 return skip;
4525}
4526
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004527bool PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
4528 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4529 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(device_data, imageView);
4530 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4531
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004532 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004533 if (image_view_state) {
4534 skip |= ValidateObjectNotInUse(device_data, image_view_state, obj_struct, "vkDestroyImageView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004535 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004536 }
4537 return skip;
4538}
4539
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004540void PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
4541 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4542 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(device_data, imageView);
4543 if (!image_view_state) return;
4544 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4545
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004546 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004547 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004548 (*GetImageViewMap(device_data)).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004549}
4550
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004551bool PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4552 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4553 auto buffer_state = GetBufferState(device_data, buffer);
4554
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004555 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004556 if (buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004557 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004558 }
4559 return skip;
4560}
4561
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004562void PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4563 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4564 if (!buffer) return;
4565 auto buffer_state = GetBufferState(device_data, buffer);
4566 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4567
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004568 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004569 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4570 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4571 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004572 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004573 }
4574 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004575 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004576 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004577 GetBufferMap(device_data)->erase(buffer_state->buffer);
4578}
4579
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004580bool PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
4581 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4582 auto buffer_view_state = GetBufferViewState(device_data, bufferView);
4583 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004584 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004585 if (buffer_view_state) {
4586 skip |= ValidateObjectNotInUse(device_data, buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004587 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004588 }
4589 return skip;
4590}
4591
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004592void PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
4593 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4594 if (!bufferView) return;
4595 auto buffer_view_state = GetBufferViewState(device_data, bufferView);
4596 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4597
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004598 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004599 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004600 GetBufferViewMap(device_data)->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004601}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004602
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004603bool PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset, VkDeviceSize size,
4604 uint32_t data) {
4605 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4606 auto cb_node = GetCBNode(device_data, commandBuffer);
4607 auto buffer_state = GetBufferState(device_data, dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004608 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004609 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004610 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004611 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4612 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004613 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4614 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004615 skip |=
4616 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4617 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004618 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004619 return skip;
4620}
4621
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004622void PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset, VkDeviceSize size,
4623 uint32_t data) {
4624 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4625 auto cb_node = GetCBNode(device_data, commandBuffer);
4626 auto buffer_state = GetBufferState(device_data, dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004627 // Update bindings between buffer and cmd buffer
4628 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004629}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004630
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004631bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4632 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004633 bool skip = false;
4634
4635 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004636 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4637 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004638 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004639 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004640 "%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 -06004641 "and 1, respectively.",
4642 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004643 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004644 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004645
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004646 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4647 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004648 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 -06004649 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004650 "%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 -06004651 "must be 0 and 1, respectively.",
4652 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004653 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004654 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004655
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004656 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4657 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004658 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 -06004659 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004660 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4661 "For 3D images these must be 0 and 1, respectively.",
4662 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004663 }
4664 }
4665
4666 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004667 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
4668 uint32_t element_size = FormatElementSize(image_state->createInfo.format);
4669 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004670 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 -06004671 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004672 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004673 " must be a multiple of this format's texel size (%" PRIu32 ").",
4674 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004675 }
4676
4677 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004678 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004679 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004680 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004681 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4682 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004683 }
4684
4685 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4686 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004687 skip |=
4688 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004689 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004690 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4691 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004692 }
4693
4694 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4695 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4696 skip |= log_msg(
4697 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004698 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004699 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4700 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004701 }
4702
4703 // subresource aspectMask must have exactly 1 bit set
4704 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4705 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4706 if (aspect_mask_bits.count() != 1) {
4707 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 -06004708 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004709 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004710 }
4711
4712 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004713 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004714 skip |= log_msg(
4715 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004716 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004717 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4718 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004719 }
4720
4721 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004722 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004723 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004724
4725 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004726 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004727 skip |= log_msg(
4728 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-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004730 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4731 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004732 }
4733
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004734 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004735 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004736 skip |= log_msg(
4737 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004738 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004739 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4740 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004741 }
4742
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004743 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004744 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4745 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4746 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004747 skip |=
4748 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004749 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004750 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4751 "width & height (%d, %d)..",
4752 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004753 }
4754
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004755 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004756 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004757 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004758 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 -06004759 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004760 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004761 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004762 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004763 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004764
4765 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004766 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004767 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004768 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4769 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 -06004770 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004771 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004772 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004773 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004774 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004775 }
4776
4777 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004778 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004779 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4780 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 -06004781 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004782 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004783 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004784 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004785 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004786 }
4787
4788 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004789 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004790 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4791 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 -06004792 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004793 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004794 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004795 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004796 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004797 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004798 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004799 }
4800
4801 return skip;
4802}
4803
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004804static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004805 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004806 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004807 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004808
4809 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004810 VkExtent3D extent = pRegions[i].imageExtent;
4811 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004812
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004813 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4814 {
Dave Houlton51653902018-06-22 17:32:13 -06004815 skip |=
4816 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4817 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4818 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004819 }
4820
4821 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4822
4823 // 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 -06004824 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004825 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004826 if (image_extent.width % block_extent.width) {
4827 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4828 }
4829 if (image_extent.height % block_extent.height) {
4830 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4831 }
4832 if (image_extent.depth % block_extent.depth) {
4833 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4834 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004835 }
4836
Dave Houltonfc1a4052017-04-27 14:32:45 -06004837 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004838 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 -06004839 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004840 }
4841 }
4842
4843 return skip;
4844}
4845
Chris Forbese8ba09a2017-06-01 17:39:02 -07004846static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004847 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004848 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004849 bool skip = false;
4850
4851 VkDeviceSize buffer_size = buff_state->createInfo.size;
4852
4853 for (uint32_t i = 0; i < regionCount; i++) {
4854 VkExtent3D copy_extent = pRegions[i].imageExtent;
4855
4856 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4857 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houltona585d132019-01-18 13:05:42 -07004858 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004859
Dave Houltonf3229d52017-02-21 15:59:08 -07004860 // Handle special buffer packing rules for specific depth/stencil formats
4861 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houltona585d132019-01-18 13:05:42 -07004862 unit_size = FormatElementSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004863 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4864 switch (image_state->createInfo.format) {
4865 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004866 unit_size = FormatElementSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004867 break;
4868 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004869 unit_size = FormatElementSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004870 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004871 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004872 case VK_FORMAT_D24_UNORM_S8_UINT:
4873 unit_size = 4;
4874 break;
4875 default:
4876 break;
4877 }
4878 }
4879
Tom Cooperb2550c72018-10-15 13:08:41 +01004880 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004881 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004882 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004883 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4884 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4885
4886 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4887 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4888 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004889 }
4890
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004891 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4892 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4893 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004894 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004895 } else {
4896 // Calculate buffer offset of final copied byte, + 1.
4897 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4898 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4899 max_buffer_offset *= unit_size; // convert to bytes
4900 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004901
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004902 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004903 skip |=
4904 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4905 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004906 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004907 }
4908 }
4909
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004910 return skip;
4911}
4912
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004913bool PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4914 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4915 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4916 auto cb_node = GetCBNode(device_data, commandBuffer);
4917 auto src_image_state = GetImageState(device_data, srcImage);
4918 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4919 const debug_report_data *report_data = device_data->report_data;
4920
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004921 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4922
4923 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004924 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004925
4926 // Command pool must support graphics, compute, or transfer operations
4927 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4928
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004929 VkQueueFlags queue_flags = GetPhysicalDeviceState(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4930
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004931 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4932 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 -06004933 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004934 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004935 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004936 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004937 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004938 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004939 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004940 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004941
4942 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004943 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4944 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4945 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4946 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4947 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004948
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004949 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004950 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4951 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4952 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004953 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004954 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4955 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004956 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4957 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004958 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4959 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004960 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004961 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004962 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004963 const char *src_invalid_layout_vuid =
Cort Stratton7df30962018-05-17 19:45:57 -07004964 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4965 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4966 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004967 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004968 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4969 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004970 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004971 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4972 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004973 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004974 "vkCmdCopyImageToBuffer()",
4975 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004976 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4977 "vkCmdCopyImageToBuffer()", "imageSubresource",
4978 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4979 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4980 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4981 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004982 }
4983 return skip;
4984}
4985
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004986void PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4987 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4988 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4989 auto cb_node = GetCBNode(device_data, commandBuffer);
4990 auto src_image_state = GetImageState(device_data, srcImage);
4991 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4992
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004993 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004994 for (uint32_t i = 0; i < regionCount; ++i) {
4995 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004996 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004997 // Update bindings between buffer/image and cmd buffer
4998 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004999 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005000}
5001
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005002bool PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5003 VkImageLayout dstImageLayout, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5004 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
5005 auto cb_node = GetCBNode(device_data, commandBuffer);
5006 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
5007 auto dst_image_state = GetImageState(device_data, dstImage);
5008 const debug_report_data *report_data = device_data->report_data;
5009
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005010 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
5011
5012 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07005013 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005014
5015 // Command pool must support graphics, compute, or transfer operations
5016 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005017 VkQueueFlags queue_flags = GetPhysicalDeviceState(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005018 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5019 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 -06005020 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005021 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005022 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005023 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005024 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005025 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005026 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005027 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005028 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005029 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
5030 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
5031 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5032 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
5033 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06005034 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005035 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5036 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5037 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
5038 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5039 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04005040 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
5041 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005042 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
5043 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005044 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06005045 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005046 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06005047 const char *dst_invalid_layout_vuid =
Cort Stratton7df30962018-05-17 19:45:57 -07005048 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
5049 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5050 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005051 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07005052 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
5053 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06005054 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005055 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5056 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005057 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06005058 "vkCmdCopyBufferToImage()",
5059 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07005060 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
5061 "vkCmdCopyBufferToImage()", "imageSubresource",
5062 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5063 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
5064 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5065 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005066 }
5067 return skip;
5068}
5069
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005070void PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5071 VkImageLayout dstImageLayout, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5072 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
5073 auto cb_node = GetCBNode(device_data, commandBuffer);
5074 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
5075 auto dst_image_state = GetImageState(device_data, dstImage);
5076
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005077 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005078 for (uint32_t i = 0; i < regionCount; ++i) {
5079 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005080 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07005081 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005082 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005083}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005084
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07005085bool PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5086 VkSubresourceLayout *pLayout) {
5087 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
5088 const auto report_data = device_data->report_data;
Mike Weiblen672b58b2017-02-21 14:32:53 -07005089 bool skip = false;
5090 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5091
Dave Houlton1d960ff2018-01-19 12:17:05 -07005092 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005093 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5094 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5095 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005096 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 -06005097 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005098 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005099 }
5100
5101 IMAGE_STATE *image_entry = GetImageState(device_data, image);
5102 if (!image_entry) {
5103 return skip;
5104 }
5105
Dave Houlton1d960ff2018-01-19 12:17:05 -07005106 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005107 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005108 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5109 "VUID-vkGetImageSubresourceLayout-image-00996",
5110 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005111 }
5112
Dave Houlton1d960ff2018-01-19 12:17:05 -07005113 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005114 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005115 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5116 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5117 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5118 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005119 }
5120
Dave Houlton1d960ff2018-01-19 12:17:05 -07005121 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005122 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005123 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5124 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5125 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5126 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005127 }
5128
Dave Houlton1d960ff2018-01-19 12:17:05 -07005129 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005130 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005131 if (FormatIsMultiplane(img_format)) {
5132 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005133 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005134 if (FormatPlaneCount(img_format) > 2u) {
5135 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005136 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005137 }
5138 if (sub_aspect != (sub_aspect & allowed_flags)) {
5139 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 -06005140 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005141 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005142 ") must be a single-plane specifier flag.",
5143 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005144 }
5145 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005146 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005147 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005148 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005149 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005150 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005151 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005152 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005153 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005154 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 -06005155 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005156 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005157 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005158 }
5159 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005160
5161 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
5162 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
5163 }
5164
Mike Weiblen672b58b2017-02-21 14:32:53 -07005165 return skip;
5166}