blob: bb21779e54b568d9114e45efa24552cd67515f49 [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 Lobodzinskid42e4d22017-01-17 14:14:22 -070037#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070038
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -070039namespace core_validation {
40extern unordered_map<void *, layer_data *> layer_data_map;
41extern unordered_map<void *, instance_layer_data *> instance_layer_data_map;
42}; // namespace core_validation
43
44using core_validation::instance_layer_data_map;
45using core_validation::layer_data_map;
46
Dave Houltond9611312018-11-19 17:03:36 -070047uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
48 // uint cast applies floor()
49 return 1u + (uint32_t)log2(std::max({height, width, depth}));
50}
51
52uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
53
54uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
55
Tobin Ehlis58c884f2017-02-08 12:15:27 -070056void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070057 auto it = pCB->imageLayoutMap.find(imgpair);
58 if (it != pCB->imageLayoutMap.end()) {
59 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070060 } else {
61 assert(imgpair.hasSubresource);
62 IMAGE_CMD_BUF_LAYOUT_NODE node;
63 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
64 node.initialLayout = layout;
65 }
66 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
67 }
68}
69template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070070void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070071 ImageSubresourcePair imgpair = {image, true, range};
72 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
73 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
74 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
75 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -070076 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
77 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
78 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
79 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
80 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070081}
82
83template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070084void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070085 VkImageAspectFlags aspectMask) {
86 if (imgpair.subresource.aspectMask & aspectMask) {
87 imgpair.subresource.aspectMask = aspectMask;
88 SetLayout(device_data, pObject, imgpair, layout);
89 }
90}
91
Tony Barbourdf013b92017-01-25 12:53:48 -070092// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070093void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
94 VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070095 auto it = imageLayoutMap.find(imgpair);
96 if (it != imageLayoutMap.end()) {
97 it->second.layout = layout; // Update
98 } else {
99 imageLayoutMap[imgpair].layout = layout; // Insert
100 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700101}
102
Tobin Ehlisc8266452017-04-07 12:20:30 -0600103bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700104 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
105 const debug_report_data *report_data = core_validation::GetReportData(device_data);
106
107 if (!(imgpair.subresource.aspectMask & aspectMask)) {
108 return false;
109 }
110 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
111 imgpair.subresource.aspectMask = aspectMask;
112 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
113 if (imgsubIt == pCB->imageLayoutMap.end()) {
114 return false;
115 }
116 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200117 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 -0600118 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700119 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200120 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700121 string_VkImageLayout(imgsubIt->second.layout));
122 }
123 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200124 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 -0600125 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700126 "Cannot query for VkImage 0x%" PRIx64
127 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200128 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700129 string_VkImageLayout(imgsubIt->second.initialLayout));
130 }
131 node = imgsubIt->second;
132 return true;
133}
134
Tobin Ehlisc8266452017-04-07 12:20:30 -0600135bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700136 const VkImageAspectFlags aspectMask) {
137 if (!(imgpair.subresource.aspectMask & aspectMask)) {
138 return false;
139 }
140 const debug_report_data *report_data = core_validation::GetReportData(device_data);
141 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
142 imgpair.subresource.aspectMask = aspectMask;
143 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
144 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
145 return false;
146 }
147 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200148 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 -0600149 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700150 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200151 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700152 string_VkImageLayout(imgsubIt->second.layout));
153 }
154 layout = imgsubIt->second.layout;
155 return true;
156}
157
158// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600159bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700160 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
161 ImageSubresourcePair imgpair = {image, true, range};
162 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
163 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
164 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
165 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
166 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700167 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
168 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
169 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
170 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
171 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700172 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
173 imgpair = {image, false, VkImageSubresource()};
174 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
175 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
176 // TODO: This is ostensibly a find function but it changes state here
177 node = imgsubIt->second;
178 }
179 return true;
180}
181
182// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700183bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700184 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
185 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
186 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
187 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
188 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700189 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
190 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
191 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
192 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
193 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700194 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
195 imgpair = {imgpair.image, false, VkImageSubresource()};
196 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
197 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
198 layout = imgsubIt->second.layout;
199 }
200 return true;
201}
202
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700203bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700204 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
205 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700206 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207 if (!image_state) return false;
208 bool ignoreGlobal = false;
209 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
210 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
211 ignoreGlobal = true;
212 }
213 for (auto imgsubpair : sub_data->second) {
214 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
215 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
216 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
217 layouts.push_back(img_data->second.layout);
218 }
219 }
220 return true;
221}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700222bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
223 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700224 if (!(imgpair.subresource.aspectMask & aspectMask)) {
225 return false;
226 }
227 imgpair.subresource.aspectMask = aspectMask;
228 auto imgsubIt = imageLayoutMap.find(imgpair);
229 if (imgsubIt == imageLayoutMap.end()) {
230 return false;
231 }
232 layout = imgsubIt->second.layout;
233 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700234}
Tony Barbourdf013b92017-01-25 12:53:48 -0700235
236// find layout in supplied map
Dave Houltonb3f4b282018-02-22 16:25:16 -0700237bool FindLayout(layer_data *device_data, const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
238 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700239 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
240 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
241 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
242 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
243 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700244 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
245 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
246 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
247 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
248 }
249 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700250 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
251 imgpair = {imgpair.image, false, VkImageSubresource()};
252 auto imgsubIt = imageLayoutMap.find(imgpair);
253 if (imgsubIt == imageLayoutMap.end()) return false;
254 layout = imgsubIt->second.layout;
255 }
256 return true;
257}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700258
259// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700260void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700261 VkImage &image = imgpair.image;
Dave Houltonb3f4b282018-02-22 16:25:16 -0700262 auto &lmap = (*core_validation::GetImageLayoutMap(device_data));
263 auto data = lmap.find(imgpair);
264 if (data != lmap.end()) {
265 data->second.layout = layout; // Update
266 } else {
267 lmap[imgpair].layout = layout; // Insert
268 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700269 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
270 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
271 if (subresource == image_subresources.end()) {
272 image_subresources.push_back(imgpair);
273 }
274}
275
276// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700277void 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 -0700278 auto it = pCB->imageLayoutMap.find(imgpair);
279 if (it != pCB->imageLayoutMap.end()) {
280 it->second = node; // Update
281 } else {
282 pCB->imageLayoutMap[imgpair] = node; // Insert
283 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700284}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600285// Set image layout for given VkImageSubresourceRange struct
286void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
287 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
288 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700289 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600290 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
291 uint32_t level = image_subresource_range.baseMipLevel + level_index;
292 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
293 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
294 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700295 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
296 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600297 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600298 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700299 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
300 }
301 }
Tony-LunarG119b38a2018-12-18 09:49:16 -0700302 // For multiplane images, IMAGE_ASPECT_COLOR is an alias for all of the plane bits
303 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
304 if (FormatIsMultiplane(image_state->createInfo.format)) {
305 if (sub.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
306 sub.aspectMask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
307 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR;
308 if (FormatPlaneCount(image_state->createInfo.format) > 2) {
309 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
310 }
311 }
312 }
313 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600314 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700315 }
316 }
317}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600318// Set image layout for given VkImageSubresourceLayers struct
319void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
320 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
321 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
322 VkImageSubresourceRange image_subresource_range;
323 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
324 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
325 image_subresource_range.layerCount = image_subresource_layers.layerCount;
326 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
327 image_subresource_range.levelCount = 1;
328 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
329}
Dave Houltonddd65c52018-05-08 14:58:01 -0600330
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600331// Set image layout for all slices of an image view
John Zulauf4ccf5c02018-09-21 11:46:18 -0600332void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_VIEW_STATE *view_state,
333 const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600334 assert(view_state);
335
Dave Houltonddd65c52018-05-08 14:58:01 -0600336 IMAGE_STATE *image_state = GetImageState(device_data, view_state->create_info.image);
337 VkImageSubresourceRange sub_range = view_state->create_info.subresourceRange;
338
339 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
340 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
341 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state->create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
342 sub_range.baseArrayLayer = 0;
343 sub_range.layerCount = image_state->createInfo.extent.depth;
344 }
345
346 SetImageLayout(device_data, cb_node, image_state, sub_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600347}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700348
John Zulauf4ccf5c02018-09-21 11:46:18 -0600349void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
350 auto view_state = GetImageViewState(device_data, imageView);
351 SetImageViewLayout(device_data, cb_node, view_state, layout);
352}
353
Tobias Hectorbbb12282018-10-22 15:17:59 +0100354bool ValidateRenderPassLayoutAgainstFramebufferImageUsage(layer_data *device_data, RenderPassCreateVersion rp_version,
355 VkImageLayout layout, VkImage image, VkImageView image_view,
356 VkFramebuffer framebuffer, VkRenderPass renderpass,
357 uint32_t attachment_index, const char *variable_name) {
358 bool skip = false;
359 const auto report_data = core_validation::GetReportData(device_data);
360 auto image_state = GetImageState(device_data, image);
361 const char *vuid;
362 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
363
364 if (!image_state) {
365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
366 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
367 "Render Pass begin with renderpass 0x%" PRIx64 " uses framebuffer 0x%" PRIx64 " where pAttachments[%" PRIu32
368 "] = image view 0x%" PRIx64 ", which refers to an invalid image",
369 HandleToUint64(renderpass), HandleToUint64(framebuffer), attachment_index, HandleToUint64(image_view));
370 return skip;
371 }
372
373 auto image_usage = image_state->createInfo.usage;
374
375 // Check for layouts that mismatch image usages in the framebuffer
376 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
377 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
378 skip |=
379 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
380 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
381 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
382 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
383 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
384 HandleToUint64(renderpass), HandleToUint64(image_view));
385 }
386
387 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
388 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
389 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
390 skip |=
391 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
392 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
393 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
394 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
395 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
396 HandleToUint64(renderpass), HandleToUint64(image_view));
397 }
398
399 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
400 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
401 skip |=
402 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
403 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
404 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
405 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
406 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
407 HandleToUint64(renderpass), HandleToUint64(image_view));
408 }
409
410 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
411 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
412 skip |=
413 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
414 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
415 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
416 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
417 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
418 HandleToUint64(renderpass), HandleToUint64(image_view));
419 }
420
421 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
422 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
423 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
424 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
425 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
426 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
427 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
428 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
429 HandleToUint64(image), vuid,
430 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
431 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
432 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
433 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
434 HandleToUint64(renderpass), HandleToUint64(image_view));
435 }
436 } else {
437 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
438 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
439 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
440 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
441 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
442 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
443 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
444 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
445 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
446 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
447 HandleToUint64(renderpass), HandleToUint64(image_view));
448 }
449 }
450 return skip;
451}
452
453bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700454 const VkRenderPassBeginInfo *pRenderPassBegin,
455 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600456 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700457 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700458 auto const &framebufferInfo = framebuffer_state->createInfo;
459 const auto report_data = core_validation::GetReportData(device_data);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100460
461 auto render_pass = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->renderPass;
462 auto framebuffer = framebuffer_state->framebuffer;
463
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700464 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600465 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 -0600466 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700467 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700468 }
469 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
470 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700471 auto view_state = GetImageViewState(device_data, image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600472
473 if (!view_state) {
474 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
475 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Graeme Leese79b60cb2018-11-28 11:51:20 +0000476 "vkCmdBeginRenderPass(): framebuffer 0x%" PRIx64 " pAttachments[%" PRIu32 "] = 0x%" PRIx64
John Zulauf8e308292018-09-21 11:34:37 -0600477 " is not a valid VkImageView handle",
478 HandleToUint64(framebuffer_state->framebuffer), i, HandleToUint64(image_view));
479 continue;
480 }
481
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700482 const VkImage &image = view_state->create_info.image;
483 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700484 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100485 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
486
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700487 // TODO: Do not iterate over every possibility - consolidate where possible
488 for (uint32_t j = 0; j < subRange.levelCount; j++) {
489 uint32_t level = subRange.baseMipLevel + j;
490 for (uint32_t k = 0; k < subRange.layerCount; k++) {
491 uint32_t layer = subRange.baseArrayLayer + k;
492 VkImageSubresource sub = {subRange.aspectMask, level, layer};
493 IMAGE_CMD_BUF_LAYOUT_NODE node;
494 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700495 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700496 continue;
497 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700498 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600499 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 -0600500 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700501 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
502 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
503 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600504 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700505 }
506 }
507 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100508
509 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, initial_layout, image, image_view,
510 framebuffer, render_pass, i, "initial layout");
511
512 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, final_layout, image, image_view, framebuffer,
513 render_pass, i, "final layout");
514 }
515
516 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
517 auto &subpass = pRenderPassInfo->pSubpasses[j];
518 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
519 auto &attachment_ref = subpass.pInputAttachments[k];
520 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
521 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
522 auto view_state = GetImageViewState(device_data, image_view);
523
524 if (view_state) {
525 auto image = view_state->create_info.image;
526 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
527 image_view, framebuffer, render_pass,
528 attachment_ref.attachment, "input attachment layout");
529 }
530 }
531 }
532
533 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
534 auto &attachment_ref = subpass.pColorAttachments[k];
535 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
536 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
537 auto view_state = GetImageViewState(device_data, image_view);
538
539 if (view_state) {
540 auto image = view_state->create_info.image;
541 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
542 image_view, framebuffer, render_pass,
543 attachment_ref.attachment, "color attachment layout");
544 if (subpass.pResolveAttachments) {
545 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
546 device_data, rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
547 attachment_ref.attachment, "resolve attachment layout");
548 }
549 }
550 }
551 }
552
553 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
554 auto &attachment_ref = *subpass.pDepthStencilAttachment;
555 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
556 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
557 auto view_state = GetImageViewState(device_data, image_view);
558
559 if (view_state) {
560 auto image = view_state->create_info.image;
561 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
562 image_view, framebuffer, render_pass,
563 attachment_ref.attachment, "input attachment layout");
564 }
565 }
566 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700567 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600568 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700569}
570
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700571void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Tobias Hectorbbb12282018-10-22 15:17:59 +0100572 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700573 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf8e308292018-09-21 11:34:37 -0600574 auto image_view = GetAttachmentImageViewState(device_data, pFramebuffer, ref.attachment);
575 if (image_view) {
576 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
577 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700578 }
579}
580
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700581void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700582 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700583 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700584
585 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700586 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700587 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
588 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
589 }
590 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
591 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
592 }
593 if (subpass.pDepthStencilAttachment) {
594 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
595 }
596 }
597}
598
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600599bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700600 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700601 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
602 return false;
603 }
604 VkImageSubresource sub = {aspect, level, layer};
605 IMAGE_CMD_BUF_LAYOUT_NODE node;
606 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700607 return false;
608 }
609 bool skip = false;
610 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
611 // TODO: Set memory invalid which is in mem_tracker currently
612 } else if (node.layout != mem_barrier->oldLayout) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600613 skip = log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
614 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
615 "VUID-VkImageMemoryBarrier-oldLayout-01197",
616 "For image 0x%" PRIx64
617 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
618 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
619 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700620 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700621 return skip;
622}
623
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700624// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
625// 1. Transition into initialLayout state
626// 2. Transition from initialLayout to layout used in subpass 0
627void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
628 FRAMEBUFFER_STATE *framebuffer_state) {
629 // First transition into initialLayout
630 auto const rpci = render_pass_state->createInfo.ptr();
631 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -0600632 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
633 if (view_state) {
634 SetImageViewLayout(device_data, cb_state, view_state, rpci->pAttachments[i].initialLayout);
635 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700636 }
637 // Now transition for first subpass (index 0)
638 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
639}
640
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700641void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
Tony-LunarG0d27b302018-10-08 09:26:21 -0600642 uint32_t level, uint32_t layer, VkImageAspectFlags aspect_mask, VkImageAspectFlags aspect) {
643 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700644 return;
645 }
646 VkImageSubresource sub = {aspect, level, layer};
647 IMAGE_CMD_BUF_LAYOUT_NODE node;
648 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700649 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700650 SetLayout(device_data, pCB, mem_barrier->image, sub,
651 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
652 return;
653 }
654 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
655 // TODO: Set memory invalid
656 }
657 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
658}
659
Dave Houlton10b39482017-03-16 13:18:15 -0600660bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600661 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600662 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600663 }
664 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600665 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600666 }
667 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600668 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600669 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700670 if (0 !=
671 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
672 if (FormatPlaneCount(format) == 1) return false;
673 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600674 return true;
675}
676
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
678bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
679 VkImageUsageFlags usage_flags, const char *func_name) {
680 const auto report_data = core_validation::GetReportData(device_data);
681 bool skip = false;
682 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Dave Houlton8e9f6542018-05-18 12:18:22 -0600683 std::string msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684
685 switch (layout) {
686 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
687 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600688 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700689 }
690 break;
691 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
692 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600693 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700694 }
695 break;
696 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
697 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600698 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700699 }
700 break;
701 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
702 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600703 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700704 }
705 break;
706 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
707 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600708 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700709 }
710 break;
711 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
712 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600713 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700714 }
715 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600716 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500717 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
718 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
719 }
720 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700721 default:
722 // Other VkImageLayout values do not have VUs defined in this context.
723 break;
724 }
725
Dave Houlton8e9f6542018-05-18 12:18:22 -0600726 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600727 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 -0600728 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600729 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
730 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
731 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700732 }
733 return skip;
734}
735
John Zulauf463c51e2018-05-31 13:29:20 -0600736// Scoreboard for checking for duplicate and inconsistent barriers to images
737struct ImageBarrierScoreboardEntry {
738 uint32_t index;
739 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
740 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
741 const VkImageMemoryBarrier *barrier;
742};
743using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
744using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
745
Mike Weiblen62d08a32017-03-07 22:18:27 -0700746// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600747bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700748 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700749 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700750
John Zulauf463c51e2018-05-31 13:29:20 -0600751 // Scoreboard for duplicate layout transition barriers within the list
752 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
753 ImageBarrierScoreboardImageMap layout_transitions;
754
Mike Weiblen62d08a32017-03-07 22:18:27 -0700755 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
756 auto img_barrier = &pImageMemoryBarriers[i];
757 if (!img_barrier) continue;
758
John Zulauf463c51e2018-05-31 13:29:20 -0600759 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
760 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
761 // at a per sub-resource level
762 if (img_barrier->oldLayout != img_barrier->newLayout) {
763 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
764 auto image_it = layout_transitions.find(img_barrier->image);
765 if (image_it != layout_transitions.end()) {
766 auto &subres_map = image_it->second;
767 auto subres_it = subres_map.find(img_barrier->subresourceRange);
768 if (subres_it != subres_map.end()) {
769 auto &entry = subres_it->second;
770 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
771 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
772 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
773 skip = log_msg(
774 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
775 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_state->commandBuffer),
776 "VUID-VkImageMemoryBarrier-oldLayout-01197",
777 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image 0x%" PRIx64
778 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
779 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
780 func_name, i, entry.index, HandleToUint64(img_barrier->image), range.aspectMask, range.baseMipLevel,
781 range.levelCount, range.baseArrayLayer, range.layerCount, string_VkImageLayout(img_barrier->oldLayout),
782 string_VkImageLayout(entry.barrier->newLayout));
783 }
784 entry = new_entry;
785 } else {
786 subres_map[img_barrier->subresourceRange] = new_entry;
787 }
788 } else {
789 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
790 }
791 }
792
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600793 auto image_state = GetImageState(device_data, img_barrier->image);
794 if (image_state) {
795 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
796 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
797 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
798
799 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
800 if (image_state->layout_locked) {
801 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600802 skip |= log_msg(
803 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Young9d1ac312018-05-21 16:28:27 -0600804 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100805 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600806 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Kraus13c98a62017-12-09 00:22:39 +0100807 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600808 string_VkImageLayout(img_barrier->newLayout));
809 }
810 }
811
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600812 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600813 // For a Depth/Stencil image both aspects MUST be set
814 if (FormatIsDepthAndStencil(image_create_info->format)) {
815 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
816 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
817 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600818 skip |=
819 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -0600820 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image),
821 "VUID-VkImageMemoryBarrier-image-01207",
Mark Lobodzinski88529492018-04-01 10:38:15 -0600822 "%s: Image barrier 0x%p references image 0x%" PRIx64
823 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
824 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
825 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600826 }
827 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600828 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
829 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700830
Mike Weiblen62d08a32017-03-07 22:18:27 -0700831 for (uint32_t j = 0; j < level_count; j++) {
832 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
833 for (uint32_t k = 0; k < layer_count; k++) {
834 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600835 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
836 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
837 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
838 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700839 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
840 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
841 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
842 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
843 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
844 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
845 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
846 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700847 }
848 }
849 }
850 return skip;
851}
852
Chris Forbes4de4b132017-08-21 11:27:08 -0700853static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600854 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700855
856 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600857 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700858}
859
John Zulauf6b4aae82018-05-09 13:03:36 -0600860template <typename Barrier>
861bool ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
862 uint32_t barrier_count, const Barrier *barriers) {
863 using BarrierRecord = QFOTransferBarrier<Barrier>;
864 bool skip = false;
865 const auto report_data = core_validation::GetReportData(device_data);
866 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
867 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
868 const char *barrier_name = BarrierRecord::BarrierName();
869 const char *handle_name = BarrierRecord::HandleName();
870 const char *transfer_type = nullptr;
871 for (uint32_t b = 0; b < barrier_count; b++) {
872 if (!IsTransferOp(&barriers[b])) continue;
873 const BarrierRecord *barrier_record = nullptr;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600874 if (IsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600875 const auto found = barrier_sets.release.find(barriers[b]);
876 if (found != barrier_sets.release.cend()) {
877 barrier_record = &(*found);
878 transfer_type = "releasing";
879 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600880 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
881 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600882 const auto found = barrier_sets.acquire.find(barriers[b]);
883 if (found != barrier_sets.acquire.cend()) {
884 barrier_record = &(*found);
885 transfer_type = "acquiring";
886 }
887 }
888 if (barrier_record != nullptr) {
889 skip |=
890 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
891 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
892 "%s: %s at index %" PRIu32 " %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
893 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
894 func_name, barrier_name, b, transfer_type, handle_name, HandleToUint64(barrier_record->handle),
895 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
896 }
897 }
898 return skip;
899}
900
901template <typename Barrier>
902void RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
903 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
904 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
905 for (uint32_t b = 0; b < barrier_count; b++) {
906 if (!IsTransferOp(&barriers[b])) continue;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600907 if (IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600908 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600909 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
910 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600911 barrier_sets.acquire.emplace(barriers[b]);
912 }
913 }
914}
915
916bool ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
917 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
918 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
919 bool skip = false;
920 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
921 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
922 return skip;
923}
924
925void RecordBarriersQFOTransfers(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
926 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
927 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
928 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
929 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
930}
931
932template <typename BarrierRecord, typename Scoreboard>
933static bool ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
934 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
935 // Record to the scoreboard or report that we have a duplication
936 bool skip = false;
937 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
938 if (!inserted.second && inserted.first->second != cb_state) {
939 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
940 skip = log_msg(
941 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
942 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
943 "%s: %s %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
944 " duplicates existing barrier submitted in this batch from command buffer 0x%" PRIx64 ".",
945 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(), HandleToUint64(barrier.handle),
946 barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex, HandleToUint64(inserted.first->second));
947 }
948 return skip;
949}
950
951template <typename Barrier>
952static bool ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
953 QFOTransferCBScoreboards<Barrier> *scoreboards) {
954 using BarrierRecord = QFOTransferBarrier<Barrier>;
955 using TypeTag = typename BarrierRecord::Tag;
956 bool skip = false;
957 const auto report_data = core_validation::GetReportData(device_data);
958 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
959 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
960 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
961 const char *barrier_name = BarrierRecord::BarrierName();
962 const char *handle_name = BarrierRecord::HandleName();
963 // No release should have an extant duplicate (WARNING)
964 for (const auto &release : cb_barriers.release) {
965 // Check the global pending release barriers
966 const auto set_it = global_release_barriers.find(release.handle);
967 if (set_it != global_release_barriers.cend()) {
968 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
969 const auto found = set_for_handle.find(release);
970 if (found != set_for_handle.cend()) {
971 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
972 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
973 "%s: %s releasing queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
974 " to dstQueueFamilyIndex %" PRIu32
975 " duplicates existing barrier queued for execution, without intervening acquire operation.",
976 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(found->handle),
977 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
978 }
979 }
980 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
981 }
982 // Each acquire must have a matching release (ERROR)
983 for (const auto &acquire : cb_barriers.acquire) {
984 const auto set_it = global_release_barriers.find(acquire.handle);
985 bool matching_release_found = false;
986 if (set_it != global_release_barriers.cend()) {
987 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
988 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
989 }
990 if (!matching_release_found) {
991 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
992 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Petr Krausfd505102018-12-17 15:18:01 +0100993 "%s: in submitted command buffer %s acquiring ownership of %s (0x%" PRIx64
John Zulauf6b4aae82018-05-09 13:03:36 -0600994 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
995 " has no matching release barrier queued for execution.",
996 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(acquire.handle),
997 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
998 }
999 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1000 }
1001 return skip;
1002}
1003
1004bool ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
1005 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
1006 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
1007 bool skip = false;
1008 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
1009 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
1010 return skip;
1011}
1012
1013template <typename Barrier>
1014static void RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1015 using BarrierRecord = QFOTransferBarrier<Barrier>;
1016 using TypeTag = typename BarrierRecord::Tag;
1017 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
1018 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1019 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
1020
1021 // Add release barriers from this submit to the global map
1022 for (const auto &release : cb_barriers.release) {
1023 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1024 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1025 global_release_barriers[release.handle].insert(release);
1026 }
1027
1028 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1029 for (const auto &acquire : cb_barriers.acquire) {
1030 // NOTE: We're not using [] because we don't want to create entries for missing releases
1031 auto set_it = global_release_barriers.find(acquire.handle);
1032 if (set_it != global_release_barriers.end()) {
1033 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1034 set_for_handle.erase(acquire);
1035 if (set_for_handle.size() == 0) { // Clean up empty sets
1036 global_release_barriers.erase(set_it);
1037 }
1038 }
1039 }
1040}
1041
1042void RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1043 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1044 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1045}
1046
1047// Remove the pending QFO release records from the global set
1048// Note that the type of the handle argument constrained to match Barrier type
1049// The defaulted BarrierRecord argument allows use to declare the type once, but is not intended to be specified by the caller
1050template <typename Barrier, typename BarrierRecord = QFOTransferBarrier<Barrier>>
1051static void EraseQFOReleaseBarriers(layer_data *device_data, const typename BarrierRecord::HandleType &handle) {
1052 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1053 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, typename BarrierRecord::Tag());
1054 global_release_barriers.erase(handle);
1055}
1056
1057// Avoid making the template globally visible by exporting the one instance of it we need.
1058void EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
1059 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1060}
1061
Chris Forbes399a6782017-08-18 15:00:48 -07001062void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001063 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001064 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1065 auto mem_barrier = &pImgMemBarriers[i];
1066 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001067
Chris Forbes4de4b132017-08-21 11:27:08 -07001068 // For ownership transfers, the barrier is specified twice; as a release
1069 // operation on the yielding queue family, and as an acquire operation
1070 // on the acquiring queue family. This barrier may also include a layout
1071 // transition, which occurs 'between' the two operations. For validation
1072 // purposes it doesn't seem important which side performs the layout
1073 // transition, but it must not be performed twice. We'll arbitrarily
1074 // choose to perform it as part of the acquire operation.
1075 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
1076 continue;
1077 }
1078
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001079 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
1080 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1081 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1082
Dave Houltonb3f4b282018-02-22 16:25:16 -07001083 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1084 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1085 // for all (potential) layer sub_resources.
1086 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1087 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1088 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1089 }
1090
Tony-LunarG0d27b302018-10-08 09:26:21 -06001091 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1092 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
1093 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1094 if (FormatIsMultiplane(image_create_info->format)) {
1095 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1096 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1097 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1098 if (FormatPlaneCount(image_create_info->format) > 2) {
1099 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1100 }
1101 }
1102 }
1103 }
1104
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001105 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001106 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001107 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001108 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Tony-LunarG0d27b302018-10-08 09:26:21 -06001109 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1110 VK_IMAGE_ASPECT_COLOR_BIT);
1111 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1112 VK_IMAGE_ASPECT_DEPTH_BIT);
1113 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1114 VK_IMAGE_ASPECT_STENCIL_BIT);
1115 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1116 VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001117 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001118 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1119 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1120 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1121 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1122 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1123 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001124 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001125 }
1126 }
1127 }
1128}
1129
Tobin Ehlisc8266452017-04-07 12:20:30 -06001130bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001131 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07001132 const char *caller, const std::string &layout_invalid_msg_code, const std::string &layout_mismatch_msg_code,
1133 bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001134 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001135 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001136 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001137
1138 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1139 uint32_t layer = i + subLayers.baseArrayLayer;
1140 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1141 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001142 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1143 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001144 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001145 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1146 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1147 "%s: Cannot use image 0x%" PRIx64
1148 " (layer=%u mip=%u) with specific layout %s that doesn't match the actual current layout %s.",
1149 caller, HandleToUint64(image), layer, subLayers.mipLevel, string_VkImageLayout(explicit_layout),
1150 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001151 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001152 }
1153 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001154 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1155 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1156 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001157 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1158 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001159 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001160 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001161 kVUID_Core_DrawState_InvalidImageLayout,
Petr Kraus13c98a62017-12-09 00:22:39 +01001162 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
1163 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001164 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001165 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001166 if (image_state->shared_presentable) {
1167 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001168 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1169 layout_invalid_msg_code,
1170 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1171 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001172 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001173 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001174 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001175 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001176 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 -07001177 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001178 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1179 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001180 }
1181 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001182 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001183}
1184
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001185void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
1186 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001187 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001188 if (!renderPass) return;
1189
Tobias Hectorbbb12282018-10-22 15:17:59 +01001190 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001191 if (framebuffer_state) {
1192 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -06001193 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
1194 if (view_state) {
1195 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
1196 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001197 }
1198 }
1199}
Dave Houltone19e20d2018-02-02 16:32:41 -07001200
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001201#ifdef VK_USE_PLATFORM_ANDROID_KHR
1202// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1203// This could also move into a seperate core_validation_android.cpp file... ?
1204
1205//
1206// AHB-specific validation within non-AHB APIs
1207//
1208bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1209 const VkImageCreateInfo *create_info) {
1210 bool skip = false;
1211
1212 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1213 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001214 if (0 != ext_fmt_android->externalFormat) {
1215 if (VK_FORMAT_UNDEFINED != create_info->format) {
1216 skip |=
1217 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1218 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001219 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001220 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1221 }
1222
1223 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1224 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1225 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001226 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001227 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1228 }
1229
1230 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1231 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1232 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001233 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001234 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1235 }
1236
1237 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1238 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1239 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001240 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001241 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1242 }
1243 }
1244
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001245 auto ahb_formats = GetAHBExternalFormatsSet(device_data);
1246 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1247 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1248 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001249 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001250 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1251 }
1252 }
1253
Dave Houltond9611312018-11-19 17:03:36 -07001254 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001255 if (VK_FORMAT_UNDEFINED == create_info->format) {
1256 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1257 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001258 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001259 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1260 }
1261 }
1262
1263 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1264 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1265 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001266 skip |=
1267 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1268 "VUID-VkImageCreateInfo-pNext-02393",
1269 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1270 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1271 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001272 }
1273
1274 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1275 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1276 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001277 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001278 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1279 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1280 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1281 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001282 }
1283
1284 return skip;
1285}
1286
1287void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
1288 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1289 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1290 is_node->imported_ahb = true;
1291 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001292 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1293 if (ext_fmt_android) {
1294 is_node->has_ahb_format = true;
1295 is_node->ahb_format = ext_fmt_android->externalFormat;
1296 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001297}
1298
1299bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
1300 bool skip = false;
1301 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houltond3e046d2018-11-28 13:08:09 -07001302 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
1303
1304 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001305 if (VK_FORMAT_UNDEFINED != create_info->format) {
1306 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1307 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1308 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1309 "format member is %s.",
1310 string_VkFormat(create_info->format));
1311 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001312
Dave Houltond9611312018-11-19 17:03:36 -07001313 // Chain must include a compatible ycbcr conversion
1314 bool conv_found = false;
1315 uint64_t external_format = 0;
1316 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1317 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001318 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
1319 auto fmap = GetYcbcrConversionFormatMap(device_data);
Dave Houltond9611312018-11-19 17:03:36 -07001320 if (fmap->find(conv_handle) != fmap->end()) {
1321 conv_found = true;
1322 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001323 }
Dave Houltond9611312018-11-19 17:03:36 -07001324 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001325 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001326 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 -07001327 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1328 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1329 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1330 }
1331
1332 // Errors in create_info swizzles
1333 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1334 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1335 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1336 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1337 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1338 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1339 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1340 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001341 }
1342 }
Dave Houltond9611312018-11-19 17:03:36 -07001343
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001344 return skip;
1345}
1346
1347bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
1348 bool skip = false;
1349 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1350
1351 IMAGE_STATE *image_state = GetImageState(device_data, image);
1352 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1353 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1354 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001355 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001356 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1357 "bound to memory.");
1358 }
1359 return skip;
1360}
1361
1362#else
1363
1364bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1365 const VkImageCreateInfo *create_info) {
1366 return false;
1367}
1368
1369void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
1370
1371bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
1372
1373bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
1374
1375#endif // VK_USE_PLATFORM_ANDROID_KHR
1376
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001377bool PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
1378 VkImage *pImage) {
1379 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), core_validation::layer_data_map);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001380 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001381 const debug_report_data *report_data = GetReportData(device_data);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001382
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001383 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1384 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1385 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1386 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1387 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1388 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001389 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001390 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001391 }
1392
Dave Houlton130c0212018-01-29 13:39:56 -07001393 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001394 skip |= log_msg(
1395 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1396 "VUID-VkImageCreateInfo-flags-00949",
1397 "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 -07001398 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001399
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07001400 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001401 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1402 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1403 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001404 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 +00001405 "VUID-VkImageCreateInfo-usage-00964",
1406 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1407 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001408 }
1409
1410 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001411 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 +00001412 "VUID-VkImageCreateInfo-usage-00965",
1413 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1414 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001415 }
1416
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001417 VkImageFormatProperties format_limits = {};
1418 VkResult res = GetPDImageFormatProperties(device_data, pCreateInfo, &format_limits);
1419 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1420 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1421 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1422 string_VkFormat(pCreateInfo->format));
1423 } else {
1424 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1425 const char *format_string = string_VkFormat(pCreateInfo->format);
1426 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1427 "VUID-VkImageCreateInfo-mipLevels-02255",
1428 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1429 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1430 }
Dave Houlton130c0212018-01-29 13:39:56 -07001431
Dave Houltona585d132019-01-18 13:05:42 -07001432 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1433 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1434 (uint64_t)pCreateInfo->samples;
1435 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001436
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001437 // Round up to imageGranularity boundary
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07001438 VkDeviceSize imageGranularity = GetPDProperties(device_data)->limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001439 uint64_t ig_mask = imageGranularity - 1;
1440 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001441
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001442 if (total_size > format_limits.maxResourceSize) {
1443 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1444 kVUID_Core_Image_InvalidFormatLimitsViolation,
1445 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1446 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1447 total_size, format_limits.maxResourceSize);
1448 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001449
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001450 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1451 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1452 "VUID-VkImageCreateInfo-arrayLayers-02256",
1453 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1454 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1455 }
1456
1457 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1458 skip |=
1459 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1460 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001461 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001462 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001463 }
1464
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06001465 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) &&
1466 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001467 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 -06001468 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001469 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1470 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001471 }
1472
Lenny Komowb79f04a2017-09-18 17:07:00 -06001473 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1474 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1475 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1476 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1477 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001478 skip |=
1479 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1480 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1481 "format must be block, ETC or ASTC compressed, but is %s",
1482 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001483 }
1484 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1485 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001486 skip |=
1487 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1488 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1489 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001490 }
1491 }
1492 }
1493
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001494 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001495}
1496
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001497void PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
1498 VkImage *pImage) {
1499 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), core_validation::layer_data_map);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001500 IMAGE_LAYOUT_NODE image_state;
1501 image_state.layout = pCreateInfo->initialLayout;
1502 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001503 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
1504 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1505 RecordCreateImageANDROID(pCreateInfo, is_node);
1506 }
1507 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001508 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001509 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1510 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001511}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001512
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001513bool PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1514 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
1515 IMAGE_STATE *image_state = core_validation::GetImageState(device_data, image);
1516 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001517 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001518 if (image_state) {
1519 skip |= core_validation::ValidateObjectNotInUse(device_data, image_state, obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001520 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001521 }
1522 return skip;
1523}
1524
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001525void PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1526 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
1527 IMAGE_STATE *image_state = core_validation::GetImageState(device_data, image);
1528 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001529 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001530 // Clean up memory mapping, bindings and range references for image
1531 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001532 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001533 if (mem_info) {
1534 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1535 }
1536 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001537 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001538 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001539 // Remove image from imageMap
1540 core_validation::GetImageMap(device_data)->erase(image);
1541 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1542 core_validation::GetImageSubresourceMap(device_data);
1543
1544 const auto &sub_entry = imageSubresourceMap->find(image);
1545 if (sub_entry != imageSubresourceMap->end()) {
1546 for (const auto &pair : sub_entry->second) {
1547 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1548 }
1549 imageSubresourceMap->erase(sub_entry);
1550 }
1551}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001552
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001553bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001554 bool skip = false;
1555 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1556
1557 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1558 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1559 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 -06001560 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001561 }
1562
Dave Houlton1d2022c2017-03-29 11:43:58 -06001563 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001564 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1565 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 -06001566 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001567 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001568 char const str[] = "vkCmdClearColorImage called with compressed image.";
1569 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 -06001570 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001571 }
1572
1573 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1574 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1575 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 -06001576 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001577 }
1578 return skip;
1579}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001580
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001581uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1582 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1583 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001584 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001585 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001586 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001587 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001588}
1589
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001590uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1591 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1592 uint32_t array_layer_count = range->layerCount;
1593 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1594 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001595 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001596 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001597}
1598
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001599bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001600 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1601 bool skip = false;
1602 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1603
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001604 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1605 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001606
1607 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1608 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001609 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1610 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001611 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 -06001612 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001613 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1614 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001615 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001616 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001617 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001618 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 -06001619 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001620 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1621 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001622
1623 } else {
1624 if (image_state->shared_presentable) {
1625 skip |= log_msg(
1626 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001627 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001628 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1629 string_VkImageLayout(dest_image_layout));
1630 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001631 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001632 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001633 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001634 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001635 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001636 } else {
1637 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1638 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001639 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 -06001640 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001641 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1642 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643 }
1644 }
1645
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001646 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1647 uint32_t level = level_index + range.baseMipLevel;
1648 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1649 uint32_t layer = layer_index + range.baseArrayLayer;
1650 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001651 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001652 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001653 if (node.layout != dest_image_layout) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001654 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001655 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001656 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001657 } else {
1658 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1659 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001660 skip |=
1661 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1662 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1663 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001664 }
1665 }
1666 }
1667 }
1668
1669 return skip;
1670}
1671
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001672void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1673 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001674 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1675 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1676 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001677
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001678 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1679 uint32_t level = level_index + range.baseMipLevel;
1680 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1681 uint32_t layer = layer_index + range.baseArrayLayer;
1682 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001683 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001684 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1685 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 -07001686 }
1687 }
1688 }
1689}
1690
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001691bool PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1692 const VkClearColorValue *pColor, uint32_t rangeCount,
1693 const VkImageSubresourceRange *pRanges) {
1694 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1695
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001696 bool skip = false;
1697 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001698 auto cb_node = GetCBNode(device_data, commandBuffer);
1699 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001700 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001701 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearColorImage()",
1702 "VUID-vkCmdClearColorImage-image-00003");
1703 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001704 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001705 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
1706 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1707 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
1708 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993",
1709 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001710 }
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001711 skip |= InsideRenderPass(device_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001712 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001713 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001714 skip |= ValidateCmdClearColorSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
1715 skip |= ValidateImageAttributes(device_data, image_state, pRanges[i]);
1716 skip |= VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001717 }
1718 }
1719 return skip;
1720}
1721
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001722void PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1723 const VkClearColorValue *pColor, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1724 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1725
1726 auto cb_node = GetCBNode(device_data, commandBuffer);
1727 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001728 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001729 AddCommandBufferBindingImage(device_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001730 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001731 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001732 }
1733 }
1734}
1735
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001736bool PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1737 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001738 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001739 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001740 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001741 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1742
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001743 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001744 auto cb_node = GetCBNode(device_data, commandBuffer);
1745 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001746 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001747 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1748 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001749 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001750 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001751 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001752 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1753 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001754 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1755 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001756 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001757 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001758 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001759 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001760 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001761 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001762 skip |=
1763 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001764 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001765 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1766 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001767 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001768 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1769 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001770 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 -06001771 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001772 }
1773 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001774 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001775 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001776 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 -06001777 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001778 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001779 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1780 char const str[] =
1781 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1782 "set.";
1783 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 -06001784 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001785 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001786 }
1787 return skip;
1788}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001789
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001790void PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1791 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1792 const VkImageSubresourceRange *pRanges) {
1793 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1794
1795 auto cb_node = GetCBNode(device_data, commandBuffer);
1796 auto image_state = GetImageState(device_data, image);
1797 if (cb_node && image_state) {
1798 AddCommandBufferBindingImage(device_data, cb_node, image_state);
1799 for (uint32_t i = 0; i < rangeCount; ++i) {
1800 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
1801 }
1802 }
1803}
1804
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001805// Returns true if [x, xoffset] and [y, yoffset] overlap
1806static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1807 bool result = false;
1808 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1809 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1810
1811 if (intersection_max > intersection_min) {
1812 result = true;
1813 }
1814 return result;
1815}
1816
Dave Houltonc991cc92018-03-06 11:08:51 -07001817// Returns true if source area of first copy region intersects dest area of second region
1818// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1819static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001820 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001821
Dave Houltonc991cc92018-03-06 11:08:51 -07001822 // Separate planes within a multiplane image cannot intersect
1823 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001824 return result;
1825 }
1826
Dave Houltonc991cc92018-03-06 11:08:51 -07001827 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1828 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1829 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001830 result = true;
1831 switch (type) {
1832 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001833 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001834 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001835 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001836 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001837 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001838 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001839 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001840 break;
1841 default:
1842 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1843 assert(false);
1844 }
1845 }
1846 return result;
1847}
1848
Dave Houltonfc1a4052017-04-27 14:32:45 -06001849// Returns non-zero if offset and extent exceed image extents
1850static const uint32_t x_bit = 1;
1851static const uint32_t y_bit = 2;
1852static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001853static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001854 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001855 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001856 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1857 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001858 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001859 }
1860 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1861 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001862 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001863 }
1864 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1865 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001866 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001867 }
1868 return result;
1869}
1870
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001871// Test if two VkExtent3D structs are equivalent
1872static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1873 bool result = true;
1874 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1875 (extent->depth != other_extent->depth)) {
1876 result = false;
1877 }
1878 return result;
1879}
1880
Dave Houltonee281a52017-12-08 13:51:02 -07001881// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1882// Destination image texel extents must be adjusted by block size for the dest validation checks
1883VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1884 VkExtent3D adjusted_extent = extent;
1885 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001886 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001887 adjusted_extent.width /= block_size.width;
1888 adjusted_extent.height /= block_size.height;
1889 adjusted_extent.depth /= block_size.depth;
1890 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001891 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001892 adjusted_extent.width *= block_size.width;
1893 adjusted_extent.height *= block_size.height;
1894 adjusted_extent.depth *= block_size.depth;
1895 }
1896 return adjusted_extent;
1897}
1898
Dave Houlton6f9059e2017-05-02 17:15:13 -06001899// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001900static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1901 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001902
1903 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001904 if (mip >= img->createInfo.mipLevels) {
1905 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001906 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001907
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001908 // 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 -06001909 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001910
Dave Houltone48cd112019-01-03 17:01:18 -07001911 // If multi-plane, adjust per-plane extent
1912 if (FormatIsMultiplane(img->createInfo.format)) {
1913 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1914 extent.width /= divisors.width;
1915 extent.height /= divisors.height;
1916 }
1917
Jeff Bolzef40fec2018-09-01 22:04:34 -05001918 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1919 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001920 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001921 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1922 } else {
1923 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1924 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1925 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1926 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001927
Dave Houlton6f9059e2017-05-02 17:15:13 -06001928 // Image arrays have an effective z extent that isn't diminished by mip level
1929 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001930 extent.depth = img->createInfo.arrayLayers;
1931 }
1932
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001933 return extent;
1934}
1935
1936// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001937static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001938 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1939}
1940
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001941// Test if the extent argument has any dimensions set to 0.
1942static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1943 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1944}
1945
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001946// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1947static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1948 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1949 VkExtent3D granularity = {0, 0, 0};
1950 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1951 if (pPool) {
1952 granularity =
1953 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001954 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001955 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001956 granularity.width *= block_size.width;
1957 granularity.height *= block_size.height;
1958 }
1959 }
1960 return granularity;
1961}
1962
1963// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1964static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1965 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001966 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1967 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001968 valid = false;
1969 }
1970 return valid;
1971}
1972
1973// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1974static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001975 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001976 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001977 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1978 bool skip = false;
1979 VkExtent3D offset_extent = {};
1980 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1981 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1982 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001983 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001984 // If the queue family image transfer granularity is (0, 0, 0), then the offset must always be (0, 0, 0)
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001985 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001986 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 -04001987 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001988 "%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 "
1989 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001990 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001991 }
1992 } else {
1993 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1994 // integer multiples of the image transfer granularity.
1995 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001996 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 -04001997 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001998 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1999 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002000 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2001 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002002 }
2003 }
2004 return skip;
2005}
2006
2007// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
2008static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
2009 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002010 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06002011 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002012 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2013 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002014 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002015 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2016 // subresource extent.
2017 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002018 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 -04002019 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002020 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2021 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2022 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2023 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002024 }
2025 } else {
2026 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2027 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2028 // subresource extent dimensions.
2029 VkExtent3D offset_extent_sum = {};
2030 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2031 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2032 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002033 bool x_ok = true;
2034 bool y_ok = true;
2035 bool z_ok = true;
2036 switch (image_type) {
2037 case VK_IMAGE_TYPE_3D:
2038 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2039 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002040 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002041 case VK_IMAGE_TYPE_2D:
2042 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2043 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002044 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002045 case VK_IMAGE_TYPE_1D:
2046 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2047 (subresource_extent->width == offset_extent_sum.width));
2048 break;
2049 default:
2050 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2051 assert(false);
2052 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002053 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002054 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 -04002055 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002056 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2057 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2058 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2059 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2060 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2061 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002062 }
2063 }
2064 return skip;
2065}
2066
Cort Strattonff1542a2018-05-27 10:49:28 -07002067bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
2068 const uint32_t i, const char *function, const char *member, const std::string &vuid) {
2069 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2070 bool skip = false;
2071 if (mip_level >= img->createInfo.mipLevels) {
2072 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2073 HandleToUint64(cb_node->commandBuffer), vuid,
2074 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
2075 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
2076 }
2077 return skip;
2078}
2079
2080bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2081 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
2082 const char *member, const std::string &vuid) {
2083 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2084 bool skip = false;
2085 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2086 (base_layer + layer_count) > img->createInfo.arrayLayers) {
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,
2089 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2090 "%u, but provided image %" PRIx64 " has %u array layers.",
2091 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
2092 }
2093 return skip;
2094}
2095
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002096// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002097bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2098 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Dave Houltone0969282018-05-23 15:54:31 -06002099 const uint32_t i, const char *function, const std::string &vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002100 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002101 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2102 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2103 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2104 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2105 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002106 return skip;
2107}
2108
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002109// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002110bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002111 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2112 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002113 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002114 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002115 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002116 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2117 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002118 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002119 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002120 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002121 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002122
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002123 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002124 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002125 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2126 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002127 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002128 const VkExtent3D dest_effective_extent =
2129 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002130 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002131 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002132 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002133 return skip;
2134}
2135
Dave Houlton6f9059e2017-05-02 17:15:13 -06002136// Validate contents of a VkImageCopy struct
2137bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
2138 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
2139 bool skip = false;
2140
2141 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002142 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002143
2144 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002145 const VkExtent3D src_copy_extent = region.extent;
2146 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002147 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2148
Dave Houlton6f9059e2017-05-02 17:15:13 -06002149 bool slice_override = false;
2150 uint32_t depth_slices = 0;
2151
2152 // Special case for copying between a 1D/2D array and a 3D image
2153 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2154 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002155 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002156 slice_override = (depth_slices != 1);
2157 } 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 -07002158 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002159 slice_override = (depth_slices != 1);
2160 }
2161
2162 // Do all checks on source image
2163 //
2164 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002165 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2166 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 -06002167 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002168 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002169 "be 0 and 1, respectively.",
2170 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002171 }
2172 }
2173
Dave Houlton533be9f2018-03-26 17:08:30 -06002174 // VUID-VkImageCopy-srcImage-01785
2175 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2176 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002177 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002178 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002179 "these must be 0 and 1, respectively.",
2180 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002181 }
2182
Dave Houlton533be9f2018-03-26 17:08:30 -06002183 // VUID-VkImageCopy-srcImage-01787
2184 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2185 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 -06002186 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002187 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2188 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002189 }
2190
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002191 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002192 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002193 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002194 skip |=
2195 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002196 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002197 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002198 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2199 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002200 }
2201 }
2202 } else { // Pre maint 1
2203 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002204 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002205 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 -06002206 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002207 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2208 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002209 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2210 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002211 }
2212 }
2213 }
2214
Dave Houltonc991cc92018-03-06 11:08:51 -07002215 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2216 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
2217 if (FormatIsCompressed(src_state->createInfo.format) ||
2218 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002219 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002220 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002221 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2222 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2223 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002224 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002225 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 -07002226 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002228 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002229 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002230 }
2231
Dave Houlton94a00372017-12-14 15:08:47 -07002232 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002233 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2234 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002235 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002236 skip |=
2237 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002238 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002239 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002240 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002241 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002242 }
2243
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002244 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002245 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2246 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002247 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002248 skip |=
2249 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002250 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002251 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002252 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002253 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002254 }
2255
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002256 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002257 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2258 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002259 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002260 skip |=
2261 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002262 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002263 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002264 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002265 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002266 }
2267 } // Compressed
2268
2269 // Do all checks on dest image
2270 //
2271 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002272 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002273 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 -06002274 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002275 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002276 "these must be 0 and 1, respectively.",
2277 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002278 }
2279 }
2280
Dave Houlton533be9f2018-03-26 17:08:30 -06002281 // VUID-VkImageCopy-dstImage-01786
2282 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2283 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 -06002284 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002285 "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 -06002286 "and 1, respectively.",
2287 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002288 }
2289
2290 // VUID-VkImageCopy-dstImage-01788
2291 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2292 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 -06002293 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002294 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2295 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002296 }
2297
2298 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002299 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002300 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 -06002301 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002302 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002303 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2304 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002305 }
2306 }
2307 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002308 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002309 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002310 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002311 skip |=
2312 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002313 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002314 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002315 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2316 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002317 }
2318 }
2319 } else { // Pre maint 1
2320 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002321 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002322 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 -06002323 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002324 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2325 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002326 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2327 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002328 }
2329 }
2330 }
2331
Dave Houltonc991cc92018-03-06 11:08:51 -07002332 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2333 if (FormatIsCompressed(dst_state->createInfo.format) ||
2334 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002335 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336
2337 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002338 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2339 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2340 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002341 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002342 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 -07002343 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002344 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002345 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002346 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002347 }
2348
Dave Houlton94a00372017-12-14 15:08:47 -07002349 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002350 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2351 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002352 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002353 skip |=
2354 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002355 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002356 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002357 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002358 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002359 }
2360
Dave Houltonee281a52017-12-08 13:51:02 -07002361 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2362 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2363 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002364 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002365 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 -07002366 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002367 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2368 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002369 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002370 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002371 }
2372
Dave Houltonee281a52017-12-08 13:51:02 -07002373 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2374 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2375 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002376 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002377 skip |=
2378 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002379 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002380 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002381 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002382 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002383 }
2384 } // Compressed
2385 }
2386 return skip;
2387}
2388
Dave Houltonc991cc92018-03-06 11:08:51 -07002389// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2390bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2391 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2392 bool skip = false;
2393 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2394
2395 // Neither image is multiplane
2396 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2397 // If neither image is multi-plane the aspectMask member of src and dst must match
2398 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2399 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002400 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002401 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2402 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002403 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002404 }
2405 } else {
2406 // Source image multiplane checks
2407 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2408 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2409 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2410 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002411 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002412 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 -06002413 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002414 }
2415 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2416 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2417 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002418 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002419 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 -06002420 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002421 }
2422 // Single-plane to multi-plane
2423 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2424 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2425 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002426 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002427 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 -06002428 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002429 }
2430
2431 // Dest image multiplane checks
2432 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2433 aspect = region.dstSubresource.aspectMask;
2434 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2435 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002436 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002437 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 -06002438 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002439 }
2440 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2441 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2442 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002443 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002444 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 -06002445 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002446 }
2447 // Multi-plane to single-plane
2448 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2449 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2450 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002451 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002452 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 -06002453 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002454 }
2455 }
2456
2457 return skip;
2458}
2459
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002460bool PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2461 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageCopy *pRegions) {
2462 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2463 auto cb_node = GetCBNode(device_data, commandBuffer);
2464 auto src_image_state = GetImageState(device_data, srcImage);
2465 auto dst_image_state = GetImageState(device_data, dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002466 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002467 const debug_report_data *report_data = device_data->report_data;
2468
2469 skip = ValidateImageCopyData(device_data, report_data, regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002470
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002471 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2472
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002473 for (uint32_t i = 0; i < regionCount; i++) {
2474 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002475
2476 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2477 VkExtent3D src_copy_extent = region.extent;
2478 VkExtent3D dst_copy_extent =
2479 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2480
Dave Houlton6f9059e2017-05-02 17:15:13 -06002481 bool slice_override = false;
2482 uint32_t depth_slices = 0;
2483
2484 // Special case for copying between a 1D/2D array and a 3D image
2485 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2486 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2487 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002488 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002489 slice_override = (depth_slices != 1);
2490 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2491 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002492 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002493 slice_override = (depth_slices != 1);
2494 }
2495
Cort Strattond619a302018-05-17 19:46:32 -07002496 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2497 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002498 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2499 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2500 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2501 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2502 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2503 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2504 "VUID-vkCmdCopyImage-srcSubresource-01698");
2505 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2506 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2507 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002508
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002509 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002510 // No chance of mismatch if we're overriding depth slice count
2511 if (!slice_override) {
2512 // The number of depth slices in srcSubresource and dstSubresource must match
2513 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2514 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002515 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2516 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002517 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002518 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2519 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002520 if (src_slices != dst_slices) {
2521 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002522 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002523 << "] do not match";
2524 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 -06002525 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002526 }
2527 }
2528 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002529 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002530 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002531 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002532 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002533 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002534 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 -06002535 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002536 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002537 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002538
Dave Houltonc991cc92018-03-06 11:08:51 -07002539 // Do multiplane-specific checks, if extension enabled
2540 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2541 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2542 }
2543
Dave Houltonf5217612018-02-02 16:18:52 -07002544 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2545 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2546 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002547 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002548 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 -06002549 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002550 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002551 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002552
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002553 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002554 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002555 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002556 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002557 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2558 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002559 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002560 }
2561
2562 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002563 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002564 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002565 ss << "vkCmdCopyImage(): pRegion[" << i
2566 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002567 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 -06002568 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002569 }
2570
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002571 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2572 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2573 // 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 -07002574 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2575 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002576 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002577 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002578 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2579 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2580 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002581 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 -06002582 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002583 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002584
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002585 // 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 -07002586 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2587 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002588 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002589 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002590 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2591 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2592 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002593 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 -06002594 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002595 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002596 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002597
Dave Houltonfc1a4052017-04-27 14:32:45 -06002598 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002599 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2600 if (slice_override) src_copy_extent.depth = depth_slices;
2601 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002602 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002603 skip |=
2604 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2605 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2606 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2607 "width [%1d].",
2608 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002609 }
2610
2611 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002612 skip |=
2613 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2614 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2615 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2616 "height [%1d].",
2617 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002618 }
2619 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002620 skip |=
2621 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2622 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2623 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2624 "depth [%1d].",
2625 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002626 }
2627
Dave Houltonee281a52017-12-08 13:51:02 -07002628 // Adjust dest extent if necessary
2629 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2630 if (slice_override) dst_copy_extent.depth = depth_slices;
2631
2632 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002633 if (extent_check & x_bit) {
2634 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002635 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002636 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002637 "width [%1d].",
2638 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002639 }
2640 if (extent_check & y_bit) {
2641 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 -06002642 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002643 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002644 "height [%1d].",
2645 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002646 }
2647 if (extent_check & z_bit) {
2648 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 -06002649 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002650 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002651 "depth [%1d].",
2652 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002653 }
2654
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002655 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2656 // must not overlap in memory
2657 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002658 for (uint32_t j = 0; j < regionCount; j++) {
2659 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002660 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002661 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002662 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002663 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 -06002664 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002665 }
2666 }
2667 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002668 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002669
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002670 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2671 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2672 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002673 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002674 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2675 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002676 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 -06002677 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002678 }
2679 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002680 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002681 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2682 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 -06002683 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002684 }
2685 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002686
Dave Houlton33c22b72017-02-28 13:16:02 -07002687 // Source and dest image sample counts must match
2688 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2689 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2690 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 -06002691 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002692 }
2693
Dave Houltond8ed0212018-05-16 17:18:24 -06002694 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2695 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002696 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002697 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2698 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2699 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2700 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002701 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002702 skip |=
2703 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002704 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002705 skip |=
2706 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002707 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002708 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002709 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002710 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2711 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002712 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002713 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002714 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07002715 const std::string invalid_src_layout_vuid =
2716 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2717 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2718 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2719 const std::string invalid_dst_layout_vuid =
2720 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2721 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2722 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002723 for (uint32_t i = 0; i < regionCount; ++i) {
2724 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002725 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2726 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002727 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002728 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2729 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002730 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002731 &pRegions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002732 }
2733
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002734 return skip;
2735}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002736
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002737void PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2738 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageCopy *pRegions) {
2739 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2740 auto cb_node = GetCBNode(device_data, commandBuffer);
2741 auto src_image_state = GetImageState(device_data, srcImage);
2742 auto dst_image_state = GetImageState(device_data, dstImage);
2743
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002744 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002745 for (uint32_t i = 0; i < regionCount; ++i) {
2746 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2747 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002748 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002749 // Update bindings between images and cmd buffer
2750 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2751 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002752}
2753
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002754// Returns true if sub_rect is entirely contained within rect
2755static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2756 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2757 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2758 return false;
2759 return true;
2760}
2761
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002762bool PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002763 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002764 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2765
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002766 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002767 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002768
2769 bool skip = false;
2770 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002771 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002772 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002773 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002774 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002775 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002776 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2777 // 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 -07002778 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2779 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002780 skip |= log_msg(
2781 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002782 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002783 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2784 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2785 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002786 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002787 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002788 }
2789
2790 // Validate that attachment is in reference list of active subpass
2791 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002792 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2793 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002794 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002795
2796 for (uint32_t i = 0; i < attachmentCount; i++) {
2797 auto clear_desc = &pAttachments[i];
2798 VkImageView image_view = VK_NULL_HANDLE;
2799
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002800 if (0 == clear_desc->aspectMask) {
2801 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 -06002802 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002803 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2804 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 -06002805 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002806 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002807 if ((subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment != VK_ATTACHMENT_UNUSED) &&
2808 (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002809 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002810 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2811 "vkCmdClearAttachments() color attachment index %d is not VK_ATTACHMENT_UNUSED and is out of "
2812 "range for active subpass %d.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002813 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002814 } else {
2815 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002816 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002817 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002818 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2819 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2820 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002821 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002822 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 -06002823 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002824 }
2825 } else { // Must be depth and/or stencil
2826 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2827 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002828 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002829 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 -06002830 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002831 }
2832 if (!subpass_desc->pDepthStencilAttachment ||
2833 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2834 skip |= log_msg(
2835 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002836 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002837 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002838 } else {
2839 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2840 }
2841 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002842 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002843 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002844 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002845 // The rectangular region specified by a given element of pRects must be contained within the render area of
2846 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002847 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2848 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2849 skip |=
2850 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 -06002851 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002852 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002853 "the current render pass instance.",
2854 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002855 }
2856 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002857 const auto local_rect =
2858 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002859 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002860 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002861 return log_msg(
2862 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002863 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002864 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002865 "the current render pass instance.",
2866 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002867 }
2868 return false;
2869 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002870 }
2871 // The layers specified by a given element of pRects must be contained within every attachment that
2872 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002873 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002874 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2875 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002876 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 -06002877 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00017",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002878 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002879 "of pAttachment[%d].",
2880 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002881 }
2882 }
2883 }
2884 }
2885 }
2886 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002887}
2888
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002889bool PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2890 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageResolve *pRegions) {
2891 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2892 auto cb_node = GetCBNode(device_data, commandBuffer);
2893 auto src_image_state = GetImageState(device_data, srcImage);
2894 auto dst_image_state = GetImageState(device_data, dstImage);
2895
2896 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002897 bool skip = false;
2898 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002899 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2900 "VUID-vkCmdResolveImage-srcImage-00256");
2901 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2902 "VUID-vkCmdResolveImage-dstImage-00258");
2903 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2904 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002905 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002906 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002907 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002908 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2909 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002910
Cort Stratton7df30962018-05-17 19:45:57 -07002911 bool hit_error = false;
2912 const std::string invalid_src_layout_vuid =
2913 (src_image_state->shared_presentable &&
2914 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2915 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2916 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2917 const std::string invalid_dst_layout_vuid =
2918 (dst_image_state->shared_presentable &&
2919 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2920 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2921 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002922 // For each region, the number of layers in the image subresource should not be zero
2923 // For each region, src and dest image aspect must be color only
2924 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002925 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2926 "srcSubresource", i);
2927 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2928 "dstSubresource", i);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002929 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002930 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2931 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002932 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002933 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2934 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002935 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2936 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2937 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2938 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2939 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2940 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2941 "VUID-vkCmdResolveImage-srcSubresource-01711");
2942 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2943 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2944 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002945
2946 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002947 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2948 skip |= log_msg(
2949 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002950 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002951 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002952 }
Cort Stratton7df30962018-05-17 19:45:57 -07002953 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002954 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2955 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2956 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002957 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002958 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 -06002959 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002960 }
2961 }
2962
2963 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2964 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002965 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 -06002966 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002967 }
2968 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2969 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002970 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 -06002971 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002972 }
2973 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2974 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2975 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 -06002976 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002977 }
2978 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2979 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2980 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 -06002981 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002982 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002983 } else {
2984 assert(0);
2985 }
2986 return skip;
2987}
2988
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002989void PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2990 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageResolve *pRegions) {
2991 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2992 auto cb_node = GetCBNode(device_data, commandBuffer);
2993 auto src_image_state = GetImageState(device_data, srcImage);
2994 auto dst_image_state = GetImageState(device_data, dstImage);
2995
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002996 // Update bindings between images and cmd buffer
2997 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2998 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002999}
3000
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003001bool PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
3002 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3003 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
3004 auto cb_node = GetCBNode(device_data, commandBuffer);
3005 auto src_image_state = GetImageState(device_data, srcImage);
3006 auto dst_image_state = GetImageState(device_data, dstImage);
3007 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003008
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003009 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003010 if (cb_node) {
3011 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3012 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003013 if (cb_node && src_image_state && dst_image_state) {
3014 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003015 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003016 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003017 "VUID-vkCmdBlitImage-dstImage-00234");
3018 skip |=
3019 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3020 skip |=
3021 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
3022 skip |=
3023 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
3024 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3025 skip |=
3026 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
3027 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3028 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
3029 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003030 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003031 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04003032 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003033 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04003034 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003035 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003036
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003037 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003038
Dave Houlton33c2d252017-06-09 17:08:32 -06003039 VkFormat src_format = src_image_state->createInfo.format;
3040 VkFormat dst_format = dst_image_state->createInfo.format;
3041 VkImageType src_type = src_image_state->createInfo.imageType;
3042 VkImageType dst_type = dst_image_state->createInfo.imageType;
3043
Cort Stratton186b1a22018-05-01 20:18:06 -04003044 if (VK_FILTER_LINEAR == filter) {
3045 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003046 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3047 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003048 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003049 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
3050 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003051 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003052 }
3053
3054 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3055 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 -06003056 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003057 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003058 }
3059
Dave Houlton33c2d252017-06-09 17:08:32 -06003060 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3061 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3062 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 -06003063 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003064 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003065 }
3066
3067 // Validate consistency for unsigned formats
3068 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3069 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003070 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003071 << "the other one must also have unsigned integer format. "
3072 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3073 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003074 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003075 }
3076
3077 // Validate consistency for signed formats
3078 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3079 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003080 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003081 << "the other one must also have signed integer format. "
3082 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3083 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003084 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003085 }
3086
3087 // Validate filter for Depth/Stencil formats
3088 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3089 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003090 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003091 << "then filter must be VK_FILTER_NEAREST.";
3092 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 -06003093 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003094 }
3095
3096 // Validate aspect bits and formats for depth/stencil images
3097 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3098 if (src_format != dst_format) {
3099 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003100 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003101 << "stencil, the other one must have exactly the same format. "
3102 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3103 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003104 skip |=
3105 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3106 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003107 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003108 } // Depth or Stencil
3109
3110 // Do per-region checks
Cort Stratton7df30962018-05-17 19:45:57 -07003111 const std::string invalid_src_layout_vuid =
3112 (src_image_state->shared_presentable &&
3113 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3114 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3115 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3116 const std::string invalid_dst_layout_vuid =
3117 (dst_image_state->shared_presentable &&
3118 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3119 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3120 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003121 for (uint32_t i = 0; i < regionCount; i++) {
3122 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003123 bool hit_error = false;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003124 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003125 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3126 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003127 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003128 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3129 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003130 skip |=
3131 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3132 skip |=
3133 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003134 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3135 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3136 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3137 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3138 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3139 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3140 "VUID-vkCmdBlitImage-srcSubresource-01707");
3141 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3142 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3143 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003144 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003145 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3146 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003147 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003148 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003149 skip |=
3150 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3151 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003152 }
Dave Houlton48989f32017-05-26 15:01:46 -06003153 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3154 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003155 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003156 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003157 skip |=
3158 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3159 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003160 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003161
3162 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003163 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003164 skip |= log_msg(
3165 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3166 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3167 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003168 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003169
Dave Houlton48989f32017-05-26 15:01:46 -06003170 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003171 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 -06003172 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003173 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003174 }
Dave Houlton48989f32017-05-26 15:01:46 -06003175
Dave Houlton33c2d252017-06-09 17:08:32 -06003176 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3177 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 -06003178 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003179 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003180 "image format %s.",
3181 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003182 }
3183
3184 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3185 skip |= log_msg(
3186 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003187 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003188 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3189 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003190 }
3191
Dave Houlton48989f32017-05-26 15:01:46 -06003192 // Validate source image offsets
3193 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003194 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003195 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003196 skip |=
3197 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3198 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3199 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3200 "of (%1d, %1d). These must be (0, 1).",
3201 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003202 }
3203 }
3204
Dave Houlton33c2d252017-06-09 17:08:32 -06003205 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003206 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3207 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 -06003208 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003209 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003210 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3211 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003212 }
3213 }
3214
Dave Houlton33c2d252017-06-09 17:08:32 -06003215 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003216 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3217 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003218 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003219 skip |= log_msg(
3220 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3221 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3222 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3223 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003224 }
3225 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3226 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003227 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003228 skip |= log_msg(
3229 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003230 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003231 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003232 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003233 }
3234 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3235 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003236 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003237 skip |= log_msg(
3238 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3239 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3240 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3241 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003242 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003243 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003244 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 -06003245 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003246 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003247 }
Dave Houlton48989f32017-05-26 15:01:46 -06003248
3249 // Validate dest image offsets
3250 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003251 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003252 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003253 skip |=
3254 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3255 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3256 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3257 "(%1d, %1d). These must be (0, 1).",
3258 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003259 }
3260 }
3261
Dave Houlton33c2d252017-06-09 17:08:32 -06003262 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003263 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3264 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 -06003265 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003266 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003267 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3268 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003269 }
3270 }
3271
Dave Houlton33c2d252017-06-09 17:08:32 -06003272 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003273 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3274 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003275 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003276 skip |= log_msg(
3277 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3278 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3279 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3280 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003281 }
3282 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3283 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003284 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003285 skip |= log_msg(
3286 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003287 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003288 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003289 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003290 }
3291 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3292 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003293 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003294 skip |= log_msg(
3295 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3296 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3297 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3298 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003299 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003300 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003301 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 -06003302 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003303 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003304 }
3305
Dave Houlton33c2d252017-06-09 17:08:32 -06003306 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3307 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3308 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003309 skip |=
3310 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3311 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3312 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3313 "layerCount other than 1.",
3314 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003315 }
3316 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003317 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003318 } else {
3319 assert(0);
3320 }
3321 return skip;
3322}
3323
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003324void PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
3325 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3326 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
3327 auto cb_node = GetCBNode(device_data, commandBuffer);
3328 auto src_image_state = GetImageState(device_data, srcImage);
3329 auto dst_image_state = GetImageState(device_data, dstImage);
3330
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003331 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003332 for (uint32_t i = 0; i < regionCount; ++i) {
3333 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3334 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003335 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003336 // Update bindings between images and cmd buffer
3337 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3338 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003339}
3340
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003341// 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 -07003342bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003343 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3344 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003345 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07003346 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003347 for (auto cb_image_data : pCB->imageLayoutMap) {
3348 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003349
Dave Houltonb3f4b282018-02-22 16:25:16 -07003350 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3351 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003352 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3353 // TODO: Set memory invalid which is in mem_tracker currently
3354 } else if (imageLayout != cb_image_data.second.initialLayout) {
3355 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003356 skip |= log_msg(
3357 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003358 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003359 "Submitted command buffer expects image 0x%" PRIx64
3360 " (subresource: aspectMask 0x%X array layer %u, mip level %u) to be in layout %s--instead, image 0x%" PRIx64
3361 "'s current layout is %s.",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003362 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
3363 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003364 string_VkImageLayout(cb_image_data.second.initialLayout), HandleToUint64(cb_image_data.first.image),
3365 string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003366 } else {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003367 skip |=
3368 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3369 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3370 "Submitted command buffer expects image 0x%" PRIx64 " to be in layout %s--instead, image 0x%" PRIx64
3371 "'s current layout is %s.",
3372 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(cb_image_data.second.initialLayout),
3373 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003374 }
3375 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003376 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003377 }
3378 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003379 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003380}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003381
Tony Barbourdf013b92017-01-25 12:53:48 -07003382void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
3383 for (auto cb_image_data : pCB->imageLayoutMap) {
3384 VkImageLayout imageLayout;
3385 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3386 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3387 }
3388}
3389
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003390// Print readable FlagBits in FlagMask
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003391static std::string StringVkAccessFlags(VkAccessFlags accessMask) {
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003392 std::string result;
3393 std::string separator;
3394
3395 if (accessMask == 0) {
3396 result = "[None]";
3397 } else {
3398 result = "[";
3399 for (auto i = 0; i < 32; i++) {
3400 if (accessMask & (1 << i)) {
3401 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
3402 separator = " | ";
3403 }
3404 }
3405 result = result + "]";
3406 }
3407 return result;
3408}
3409
Dave Houlton12befb92018-06-26 17:16:46 -06003410#if 0 // This fxn seems vestigial, not called anywhere. All VkAccessFlagBits VUIDs are implicit & being checked by parameter
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003411 // validation ToBeRemoved (disabled 6/18)
Dave Houlton12befb92018-06-26 17:16:46 -06003412
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003413// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
3414// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003415// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003416static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
3417 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
3418 const char *type) {
3419 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3420 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003421
3422 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
3423 if (accessMask & ~(required_bit | optional_bits)) {
3424 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003425 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 -06003426 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003427 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003428 StringVkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003429 }
3430 } else {
3431 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003432 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 -06003433 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003434 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
3435 "has previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003436 type, accessMask, StringVkAccessFlags(accessMask).c_str(), optional_bits,
3437 StringVkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003438 } else {
3439 std::string opt_bits;
3440 if (optional_bits != 0) {
3441 std::stringstream ss;
3442 ss << optional_bits;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003443 opt_bits = "and may have optional bits " + ss.str() + ' ' + StringVkAccessFlags(optional_bits);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003444 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003445 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 -06003446 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003447 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
3448 "previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003449 type, accessMask, StringVkAccessFlags(accessMask).c_str(), required_bit,
3450 StringVkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003451 }
3452 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003453 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003454}
Dave Houlton12befb92018-06-26 17:16:46 -06003455#endif
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003456
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003457// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003458// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3459// layout attachments don't have CLEAR as their loadOp.
Tobias Hectorbbb12282018-10-22 15:17:59 +01003460bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3461 const VkImageLayout first_layout, const uint32_t attachment,
3462 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003463 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003464 const char *vuid;
3465 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3466
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003467 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3468 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003469 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3470 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3471 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003472 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003473 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3474 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3475 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3476 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3477 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3478 skip |=
3479 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3480 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003481 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003482 }
3483 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003484 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3485 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003486 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003487 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003488 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 -06003489 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003490 }
3491 }
3492
3493 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3494 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003495 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003496 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003497 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 -06003498 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003499 }
3500 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003501 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003502}
3503
Tobias Hectorbbb12282018-10-22 15:17:59 +01003504bool ValidateLayouts(const core_validation::layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3505 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003506 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003507 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003508 const char *vuid;
3509 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3510 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003511
Jason Ekstranda1906302017-12-03 20:16:32 -08003512 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3513 VkFormat format = pCreateInfo->pAttachments[i].format;
3514 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3515 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3516 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003517 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 -06003518 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003519 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3520 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3521 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3522 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003523 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003524 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003525 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 -06003526 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003527 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3528 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3529 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3530 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003531 }
3532 }
3533 }
3534
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003535 // Track when we're observing the first use of an attachment
3536 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3537 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003538 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003539
3540 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3541 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3542 auto attach_index = subpass.pInputAttachments[j].attachment;
3543 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003544 switch (subpass.pInputAttachments[j].layout) {
3545 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3546 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3547 // These are ideal.
3548 break;
3549
3550 case VK_IMAGE_LAYOUT_GENERAL:
3551 // May not be optimal. TODO: reconsider this warning based on other constraints.
3552 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003553 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003554 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3555 break;
3556
Tobias Hectorbbb12282018-10-22 15:17:59 +01003557 case VK_IMAGE_LAYOUT_UNDEFINED:
3558 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3559 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3560 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3561 "Layout for input attachment reference %u in subpass %u is %s but must be "
3562 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3563 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3564 break;
3565
Graeme Leese668a9862018-10-08 10:40:02 +01003566 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3567 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3568 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3569 break;
3570 } else {
3571 // Intentionally fall through to generic error message
3572 }
3573 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003574
Cort Stratton7547f772017-05-04 15:18:52 -07003575 default:
3576 // No other layouts are acceptable
3577 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 -06003578 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003579 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3580 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3581 }
3582
Cort Stratton7547f772017-05-04 15:18:52 -07003583 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003584 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3585 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003586
3587 bool used_as_depth =
3588 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3589 bool used_as_color = false;
3590 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3591 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3592 }
3593 if (!used_as_depth && !used_as_color &&
3594 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003595 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3596 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3597 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3598 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003599 }
3600 }
3601 attach_first_use[attach_index] = false;
3602 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003603
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003604 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3605 auto attach_index = subpass.pColorAttachments[j].attachment;
3606 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3607
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003608 // TODO: Need a way to validate shared presentable images here, currently just allowing
3609 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3610 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003611 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003612 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003613 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003614 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3615 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003616 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003617
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003618 case VK_IMAGE_LAYOUT_GENERAL:
3619 // May not be optimal; TODO: reconsider this warning based on other constraints?
3620 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003621 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003622 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3623 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003624
Tobias Hectorbbb12282018-10-22 15:17:59 +01003625 case VK_IMAGE_LAYOUT_UNDEFINED:
3626 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3627 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3628 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3629 "Layout for color attachment reference %u in subpass %u is %s but should be "
3630 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3631 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3632 break;
3633
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003634 default:
3635 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 -06003636 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003637 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3638 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003639 }
3640
Tobias Hectorbbb12282018-10-22 15:17:59 +01003641 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3642 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
3643 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3644 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3645 "Layout for color attachment reference %u in subpass %u is %s but should be "
3646 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3647 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3648 }
3649
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003650 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003651 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3652 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003653 }
3654 attach_first_use[attach_index] = false;
3655 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003656
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003657 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3658 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003659 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3660 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3661 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003662 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003663
Dave Houltona9df0ce2018-02-07 10:51:23 -07003664 case VK_IMAGE_LAYOUT_GENERAL:
3665 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3666 // doing a bunch of transitions.
3667 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003668 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003669 "GENERAL layout for depth attachment may not give optimal performance.");
3670 break;
3671
Tobias Hectorbbb12282018-10-22 15:17:59 +01003672 case VK_IMAGE_LAYOUT_UNDEFINED:
3673 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3674 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3675 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3676 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3677 "layout or GENERAL.",
3678 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3679 break;
3680
Dave Houltona9df0ce2018-02-07 10:51:23 -07003681 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3682 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3683 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3684 break;
3685 } else {
3686 // Intentionally fall through to generic error message
3687 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003688 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003689
Dave Houltona9df0ce2018-02-07 10:51:23 -07003690 default:
3691 // No other layouts are acceptable
3692 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 -06003693 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003694 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3695 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3696 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003697 }
3698
3699 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3700 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003701 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3702 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003703 }
3704 attach_first_use[attach_index] = false;
3705 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003706 }
3707 return skip;
3708}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003709
3710// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003711bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3712 VkDeviceSize offset, VkDeviceSize end_offset) {
3713 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3714 bool skip = false;
3715 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3716 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003717 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3718 for (auto image_handle : mem_info->bound_images) {
3719 auto img_it = mem_info->bound_ranges.find(image_handle);
3720 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003721 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003722 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003723 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003724 for (auto layout : layouts) {
3725 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003726 skip |=
3727 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 -06003728 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003729 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3730 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003731 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003732 }
3733 }
3734 }
3735 }
3736 }
3737 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003738 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003739}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003740
3741// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3742// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003743static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3744 VulkanObjectType obj_type, std::string msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003745 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003746
3747 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003748 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003749 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003750 if (strict) {
3751 correct_usage = ((actual & desired) == desired);
3752 } else {
3753 correct_usage = ((actual & desired) != 0);
3754 }
3755 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003756 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003757 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003758 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003759 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
Dave Houlton51653902018-06-22 17:32:13 -06003760 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003761 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3762 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003763 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003764 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003765 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003766 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3767 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003768 }
3769 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003770 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003771}
3772
3773// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3774// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003775bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003776 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003777 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3778 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003779}
3780
Cort Stratton186b1a22018-05-01 20:18:06 -04003781bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Dave Houltone0969282018-05-23 15:54:31 -06003782 char const *func_name, const std::string &linear_vuid, const std::string &optimal_vuid) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003783 VkFormatProperties format_properties = GetPDFormatProperties(dev_data, image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003784 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3785 bool skip = false;
3786 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3787 if ((format_properties.linearTilingFeatures & desired) != desired) {
3788 skip |=
3789 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3790 HandleToUint64(image_state->image), linear_vuid,
3791 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3792 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3793 }
3794 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3795 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3796 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3797 HandleToUint64(image_state->image), optimal_vuid,
3798 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3799 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3800 HandleToUint64(image_state->image));
3801 }
3802 }
3803 return skip;
3804}
3805
Cort Strattond619a302018-05-17 19:46:32 -07003806bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3807 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3808 uint32_t i) {
3809 bool skip = false;
3810 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3811 // layerCount must not be zero
3812 if (subresource_layers->layerCount == 0) {
3813 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3814 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3815 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3816 }
3817 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3818 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3819 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3820 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3821 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3822 }
3823 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3824 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3825 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3826 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3827 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3828 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3829 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3830 func_name, i, member);
3831 }
3832 return skip;
3833}
3834
Mark Lobodzinski96210742017-02-09 10:33:46 -07003835// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3836// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003837bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003838 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003839 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3840 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003841}
3842
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003843bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3844 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3845 bool skip = false;
3846 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3847
3848 const VkDeviceSize &range = pCreateInfo->range;
3849 if (range != VK_WHOLE_SIZE) {
3850 // Range must be greater than 0
3851 if (range <= 0) {
3852 skip |= 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-00928",
3854 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3855 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3856 range);
3857 }
3858 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003859 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003860 if (range % format_size != 0) {
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-range-00929",
3863 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3864 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3865 "(" PRINTF_SIZE_T_SPECIFIER ").",
3866 range, format_size);
3867 }
3868 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3869 if (range / format_size > device_limits->maxTexelBufferElements) {
3870 skip |=
3871 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3872 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3873 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3874 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3875 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3876 range, format_size, device_limits->maxTexelBufferElements);
3877 }
3878 // The sum of range and offset must be less than or equal to the size of buffer
3879 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3880 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3881 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3882 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3883 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3884 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3885 range, pCreateInfo->offset, buffer_state->createInfo.size);
3886 }
3887 }
3888 return skip;
3889}
3890
Shannon McPherson265383a2018-06-21 15:37:52 -06003891bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3892 const VkBufferViewCreateInfo *pCreateInfo) {
3893 bool skip = false;
3894 const debug_report_data *report_data = GetReportData(device_data);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003895 const VkFormatProperties format_properties = GetPDFormatProperties(device_data, pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003896 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3897 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3898 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3899 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3900 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3901 "be supported for uniform texel buffers");
3902 }
3903 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3904 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3905 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3906 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3907 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3908 "be supported for storage texel buffers");
3909 }
3910 return skip;
3911}
3912
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003913bool PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
3914 VkBuffer *pBuffer) {
3915 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3916
Mark Lobodzinski96210742017-02-09 10:33:46 -07003917 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003918 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003919
Dave Houltond8ed0212018-05-16 17:18:24 -06003920 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003921
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003922 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003923 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 -06003924 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003925 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003926 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003927 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003928
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003929 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3930 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003931 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 -06003932 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003933 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003934 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003935 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003936
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003937 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3938 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003939 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 -06003940 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003941 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003942 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003943 }
Jeff Bolz87697532019-01-11 22:54:00 -06003944
3945 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3946 if (chained_devaddr_struct) {
3947 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3948 chained_devaddr_struct->deviceAddress != 0) {
3949 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3950 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3951 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3952 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3953 }
3954 }
3955
3956 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3957 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddressCaptureReplay) {
3958 skip |= log_msg(
3959 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3960 "VUID-VkBufferCreateInfo-flags-02605",
3961 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3962 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3963 }
3964
3965 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
3966 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddress) {
3967 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3968 "VUID-VkBufferCreateInfo-usage-02606",
3969 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3970 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3971 }
3972
Mark Lobodzinski96210742017-02-09 10:33:46 -07003973 return skip;
3974}
3975
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003976void PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
3977 VkBuffer *pBuffer) {
3978 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3979
Mark Lobodzinski96210742017-02-09 10:33:46 -07003980 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3981 GetBufferMap(device_data)
3982 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3983}
3984
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003985bool PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3986 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
3987 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3988
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003989 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003990 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003991 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003992 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3993 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003994 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3995 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003996 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3997 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003998 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3999 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4000 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4001 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004002
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004003 // Buffer view offset must be less than the size of buffer
4004 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
4005 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4006 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
4007 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4008 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4009 pCreateInfo->offset, buffer_state->createInfo.size);
4010 }
4011
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07004012 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06004013 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4014 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
4015 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4016 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
4017 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4018 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4019 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4020 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004021
4022 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004023
4024 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004025 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004026 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004027}
4028
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004029void PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
4030 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
4031 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4032
Mark Lobodzinski96210742017-02-09 10:33:46 -07004033 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
4034}
Mark Lobodzinski602de982017-02-09 11:01:33 -07004035
4036// For the given format verify that the aspect masks make sense
Tobias Hectorbbb12282018-10-22 15:17:59 +01004037bool ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
4038 const char *func_name, const char *vuid) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004039 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004040 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004041 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4042 if (image != VK_NULL_HANDLE) {
4043 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4044 }
4045
Dave Houlton1d2022c2017-03-29 11:43:58 -06004046 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004047 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004048 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004049 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004050 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004051 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004052 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004053 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004054 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004055 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004056 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004057 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004058 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4059 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004060 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004061 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004062 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004063 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4064 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004065 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004066 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004067 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004068 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004069 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004070 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004071 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004072 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004073 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004074 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004075 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004076 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004077 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004078 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004079 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004080 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004081 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004082 } else if (FormatIsMultiplane(format)) {
4083 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4084 if (3 == FormatPlaneCount(format)) {
4085 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4086 }
4087 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004088 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004089 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4090 "set, where n = [0, 1, 2].",
4091 func_name);
4092 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004093 }
4094 return skip;
4095}
4096
Petr Krausffa94af2017-08-08 21:46:02 +02004097struct SubresourceRangeErrorCodes {
Dave Houltond8ed0212018-05-16 17:18:24 -06004098 std::string base_mip_err, mip_count_err, base_layer_err, layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02004099};
4100
4101bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
4102 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
4103 const char *image_layer_count_var_name, const uint64_t image_handle,
4104 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004105 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4106 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004107
4108 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004109 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004110 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 -06004111 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004112 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004113 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4114 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004115 }
Petr Kraus4d718682017-05-18 03:38:41 +02004116
Petr Krausffa94af2017-08-08 21:46:02 +02004117 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4118 if (subresourceRange.levelCount == 0) {
4119 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 -06004120 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004121 } else {
4122 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004123
Petr Krausffa94af2017-08-08 21:46:02 +02004124 if (necessary_mip_count > image_mip_count) {
4125 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.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004127 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004128 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004129 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004130 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004131 }
Petr Kraus4d718682017-05-18 03:38:41 +02004132 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004133 }
Petr Kraus4d718682017-05-18 03:38:41 +02004134
4135 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004136 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004137 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 -06004138 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004139 "%s: %s.baseArrayLayer (= %" PRIu32
4140 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4141 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004142 }
Petr Kraus4d718682017-05-18 03:38:41 +02004143
Petr Krausffa94af2017-08-08 21:46:02 +02004144 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4145 if (subresourceRange.layerCount == 0) {
4146 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 -06004147 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004148 } else {
4149 const uint64_t necessary_layer_count =
4150 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004151
Petr Krausffa94af2017-08-08 21:46:02 +02004152 if (necessary_layer_count > image_layer_count) {
4153 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 -06004154 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004155 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004156 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004157 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004158 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004159 }
Petr Kraus4d718682017-05-18 03:38:41 +02004160 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004161 }
Petr Kraus4d718682017-05-18 03:38:41 +02004162
Mark Lobodzinski602de982017-02-09 11:01:33 -07004163 return skip;
4164}
4165
Petr Krausffa94af2017-08-08 21:46:02 +02004166bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4167 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
4168 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
4169 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4170 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4171 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4172
4173 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4174 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4175
4176 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004177 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4178 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4179 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4180 : "VUID-VkImageViewCreateInfo-image-01482")
4181 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4182 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4183 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4184 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4185 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004186
4187 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4188 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4189 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4190}
4191
4192bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4193 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4194 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004195 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4196 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4197 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4198 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004199
4200 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4201 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4202 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4203}
4204
4205bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4206 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4207 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004208 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4209 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4210 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4211 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004212
4213 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4214 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4215 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4216}
4217
4218bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4219 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4220 const char *param_name) {
4221 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004222 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4223 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4224 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4225 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004226
4227 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4228 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4229 subresourceRangeErrorCodes);
4230}
4231
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004232bool PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4233 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
4234 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4235 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004236 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004237 IMAGE_STATE *image_state = GetImageState(device_data, pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004238 if (image_state) {
4239 skip |= ValidateImageUsageFlags(
4240 device_data, image_state,
4241 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004242 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4243 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004244 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004245 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004246 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004247 skip |=
4248 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004249 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004250 skip |= ValidateCreateImageViewSubresourceRange(
4251 device_data, image_state,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004252 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4253 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004254
4255 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4256 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004257 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4258 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004259 VkFormat view_format = pCreateInfo->format;
4260 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004261 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004262 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004263
Dave Houltonbd2e2622018-04-10 16:41:14 -06004264 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004265 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004266 if (chained_ivuci_struct) {
4267 if (chained_ivuci_struct->usage & ~image_usage) {
4268 std::stringstream ss;
4269 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004270 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004271 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004272 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 -07004273 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004274 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004275 }
4276
4277 image_usage = chained_ivuci_struct->usage;
4278 }
4279
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004280 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4281 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004282 if (FormatIsMultiplane(image_format)) {
4283 // View format must match the multiplane compatible format
4284 uint32_t plane = 3; // invalid
4285 switch (aspect_mask) {
4286 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4287 plane = 0;
4288 break;
4289 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4290 plane = 1;
4291 break;
4292 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4293 plane = 2;
4294 break;
4295 default:
4296 break;
4297 }
4298
4299 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4300 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004301 std::stringstream ss;
4302 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004303 << " is not compatible with plane " << plane << " of underlying image format "
4304 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004305 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 -07004306 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004307 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004308 }
4309 } else {
4310 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
4311 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4312 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4313 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4314 std::stringstream ss;
4315 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004316 << " is not in the same format compatibility class as image (" << HandleToUint64(pCreateInfo->image)
Dave Houltonc7988072018-04-16 11:46:56 -06004317 << ") format " << string_VkFormat(image_format)
4318 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4319 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004320 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 -07004321 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004322 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004323 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004324 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004325 }
4326 } else {
4327 // Format MUST be IDENTICAL to the format the image was created with
4328 if (image_format != view_format) {
4329 std::stringstream ss;
4330 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004331 << HandleToUint64(pCreateInfo->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004332 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004333 skip |=
4334 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004335 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004336 }
4337 }
4338
4339 // Validate correct image aspect bits for desired formats and format consistency
4340 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004341
4342 switch (image_type) {
4343 case VK_IMAGE_TYPE_1D:
4344 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004345 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 -07004346 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004347 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4348 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004349 }
4350 break;
4351 case VK_IMAGE_TYPE_2D:
4352 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4353 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4354 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004356 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004357 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4358 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004359 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004360 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004361 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004362 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4363 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004364 }
4365 }
4366 break;
4367 case VK_IMAGE_TYPE_3D:
4368 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4369 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4370 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4371 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004372 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004373 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004374 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004375 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4376 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004377 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4378 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004379 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004380 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004381 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004382 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4383 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004384 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4385 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004386 }
4387 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004388 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 -07004389 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004390 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4391 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004392 }
4393 }
4394 } else {
4395 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004396 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 -07004397 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004398 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4399 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004400 }
4401 }
4402 break;
4403 default:
4404 break;
4405 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004406
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004407 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
4408 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004409 skip |= ValidateCreateImageViewANDROID(device_data, pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004410 }
4411
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004412 VkFormatProperties format_properties = GetPDFormatProperties(device_data, view_format);
4413 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4414 : format_properties.optimalTilingFeatures;
4415
4416 if (tiling_features == 0) {
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-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004419 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4420 "physical device.",
4421 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4422 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4423 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 -07004424 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004425 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4426 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4427 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4428 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4429 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 -07004430 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004431 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4432 "VK_IMAGE_USAGE_STORAGE_BIT.",
4433 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4434 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4435 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4436 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 -07004437 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004438 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4439 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4440 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4441 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4442 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4443 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 -07004444 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004445 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4446 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4447 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004448 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004449
Jeff Bolz9af91c52018-09-01 21:53:57 -05004450 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4451 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4452 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 -07004453 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004454 "vkCreateImageView() If image was created with usage containing "
4455 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4456 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4457 }
4458 if (view_format != VK_FORMAT_R8_UINT) {
4459 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 -07004460 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004461 "vkCreateImageView() If image was created with usage containing "
4462 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4463 }
4464 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004465 }
4466 return skip;
4467}
4468
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004469void PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4470 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
4471 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004472 auto image_view_map = GetImageViewMap(device_data);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004473 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004474
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004475 auto image_state = GetImageState(device_data, pCreateInfo->image);
4476 auto &sub_res_range = (*image_view_map)[*pView].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004477 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4478 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004479}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004480
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004481bool PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
4482 const VkBufferCopy *pRegions) {
4483 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4484 auto cb_node = GetCBNode(device_data, commandBuffer);
4485 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
4486 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4487
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004488 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004489 skip |=
4490 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4491 skip |=
4492 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004493 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004494 skip |=
4495 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4496 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4497 skip |=
4498 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4499 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004500 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004501 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4502 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004503 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004504 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004505 return skip;
4506}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004507
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004508void PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
4509 const VkBufferCopy *pRegions) {
4510 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4511 auto cb_node = GetCBNode(device_data, commandBuffer);
4512 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
4513 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4514
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004515 // Update bindings between buffers and cmd buffer
4516 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4517 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004518}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004519
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004520static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004521 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4522 bool skip = false;
4523 auto buffer_state = GetBufferState(device_data, buffer);
4524 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004525 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
Dave Houlton51653902018-06-22 17:32:13 -06004526 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01004527 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004528 } else {
4529 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004530 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 -06004531 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004532 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004533 }
4534 }
4535 return skip;
4536}
4537
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004538bool PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
4539 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4540 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(device_data, imageView);
4541 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4542
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004543 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004544 if (image_view_state) {
4545 skip |= ValidateObjectNotInUse(device_data, image_view_state, obj_struct, "vkDestroyImageView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004546 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004547 }
4548 return skip;
4549}
4550
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004551void PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
4552 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4553 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(device_data, imageView);
4554 if (!image_view_state) return;
4555 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4556
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004557 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004558 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004559 (*GetImageViewMap(device_data)).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004560}
4561
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004562bool PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4563 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4564 auto buffer_state = GetBufferState(device_data, buffer);
4565
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004566 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004567 if (buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004568 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004569 }
4570 return skip;
4571}
4572
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004573void PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4574 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4575 if (!buffer) return;
4576 auto buffer_state = GetBufferState(device_data, buffer);
4577 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4578
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004579 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004580 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4581 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4582 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004583 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004584 }
4585 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004586 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004587 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004588 GetBufferMap(device_data)->erase(buffer_state->buffer);
4589}
4590
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004591bool PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
4592 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4593 auto buffer_view_state = GetBufferViewState(device_data, bufferView);
4594 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004595 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004596 if (buffer_view_state) {
4597 skip |= ValidateObjectNotInUse(device_data, buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004598 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004599 }
4600 return skip;
4601}
4602
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004603void PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
4604 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4605 if (!bufferView) return;
4606 auto buffer_view_state = GetBufferViewState(device_data, bufferView);
4607 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4608
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004609 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004610 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004611 GetBufferViewMap(device_data)->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004612}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004613
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004614bool PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset, VkDeviceSize size,
4615 uint32_t data) {
4616 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4617 auto cb_node = GetCBNode(device_data, commandBuffer);
4618 auto buffer_state = GetBufferState(device_data, dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004619 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004620 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004621 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004622 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4623 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004624 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4625 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004626 skip |=
4627 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4628 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004629 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004630 return skip;
4631}
4632
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004633void PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset, VkDeviceSize size,
4634 uint32_t data) {
4635 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4636 auto cb_node = GetCBNode(device_data, commandBuffer);
4637 auto buffer_state = GetBufferState(device_data, dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004638 // Update bindings between buffer and cmd buffer
4639 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004640}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004641
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004642bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4643 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004644 bool skip = false;
4645
4646 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004647 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4648 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004649 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 -06004650 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004651 "%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 -06004652 "and 1, respectively.",
4653 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004654 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004655 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004656
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004657 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4658 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004659 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 -06004660 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004661 "%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 -06004662 "must be 0 and 1, respectively.",
4663 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004664 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004665 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004666
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004667 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4668 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004669 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 -06004670 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004671 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4672 "For 3D images these must be 0 and 1, respectively.",
4673 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004674 }
4675 }
4676
4677 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004678 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
4679 uint32_t element_size = FormatElementSize(image_state->createInfo.format);
4680 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004681 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 -06004682 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004683 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004684 " must be a multiple of this format's texel size (%" PRIu32 ").",
4685 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004686 }
4687
4688 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004689 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004690 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004691 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004692 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4693 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004694 }
4695
4696 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4697 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004698 skip |=
4699 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004700 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004701 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4702 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004703 }
4704
4705 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4706 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4707 skip |= log_msg(
4708 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004709 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004710 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4711 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004712 }
4713
4714 // subresource aspectMask must have exactly 1 bit set
4715 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4716 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4717 if (aspect_mask_bits.count() != 1) {
4718 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 -06004719 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004720 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004721 }
4722
4723 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004724 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004725 skip |= log_msg(
4726 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004727 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004728 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4729 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004730 }
4731
4732 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004733 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004734 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004735
4736 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004737 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004738 skip |= log_msg(
4739 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004740 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004741 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4742 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004743 }
4744
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004745 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004746 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004747 skip |= log_msg(
4748 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-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004750 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4751 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004752 }
4753
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004754 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004755 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4756 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4757 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004758 skip |=
4759 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004760 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004761 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4762 "width & height (%d, %d)..",
4763 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004764 }
4765
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004766 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004767 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004768 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004769 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-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004771 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004772 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004773 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004774 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004775
4776 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004777 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004778 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004779 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
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-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004782 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004783 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004784 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004785 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004786 }
4787
4788 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004789 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004790 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
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-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004793 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004794 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004795 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004796 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004797 }
4798
4799 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004800 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004801 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4802 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 -06004803 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004804 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004805 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004806 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004807 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004808 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004809 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004810 }
4811
4812 return skip;
4813}
4814
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004815static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Dave Houltond8ed0212018-05-16 17:18:24 -06004816 const VkBufferImageCopy *pRegions, const char *func_name, std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004817 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004818 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004819
4820 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004821 VkExtent3D extent = pRegions[i].imageExtent;
4822 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004823
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004824 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4825 {
Dave Houlton51653902018-06-22 17:32:13 -06004826 skip |=
4827 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4828 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4829 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004830 }
4831
4832 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4833
4834 // 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 -06004835 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004836 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004837 if (image_extent.width % block_extent.width) {
4838 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4839 }
4840 if (image_extent.height % block_extent.height) {
4841 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4842 }
4843 if (image_extent.depth % block_extent.depth) {
4844 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4845 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004846 }
4847
Dave Houltonfc1a4052017-04-27 14:32:45 -06004848 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004849 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 -06004850 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004851 }
4852 }
4853
4854 return skip;
4855}
4856
Chris Forbese8ba09a2017-06-01 17:39:02 -07004857static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004858 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06004859 std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004860 bool skip = false;
4861
4862 VkDeviceSize buffer_size = buff_state->createInfo.size;
4863
4864 for (uint32_t i = 0; i < regionCount; i++) {
4865 VkExtent3D copy_extent = pRegions[i].imageExtent;
4866
4867 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4868 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houltona585d132019-01-18 13:05:42 -07004869 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004870
Dave Houltonf3229d52017-02-21 15:59:08 -07004871 // Handle special buffer packing rules for specific depth/stencil formats
4872 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houltona585d132019-01-18 13:05:42 -07004873 unit_size = FormatElementSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004874 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4875 switch (image_state->createInfo.format) {
4876 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004877 unit_size = FormatElementSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004878 break;
4879 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004880 unit_size = FormatElementSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004881 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004882 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004883 case VK_FORMAT_D24_UNORM_S8_UINT:
4884 unit_size = 4;
4885 break;
4886 default:
4887 break;
4888 }
4889 }
4890
Tom Cooperb2550c72018-10-15 13:08:41 +01004891 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004892 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004893 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004894 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4895 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4896
4897 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4898 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4899 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004900 }
4901
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004902 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4903 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4904 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004905 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004906 } else {
4907 // Calculate buffer offset of final copied byte, + 1.
4908 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4909 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4910 max_buffer_offset *= unit_size; // convert to bytes
4911 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004912
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004913 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004914 skip |=
4915 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4916 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004917 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004918 }
4919 }
4920
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004921 return skip;
4922}
4923
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004924bool PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4925 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4926 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4927 auto cb_node = GetCBNode(device_data, commandBuffer);
4928 auto src_image_state = GetImageState(device_data, srcImage);
4929 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4930 const debug_report_data *report_data = device_data->report_data;
4931
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004932 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4933
4934 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004935 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004936
4937 // Command pool must support graphics, compute, or transfer operations
4938 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4939
4940 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4941 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4942 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 -06004943 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004944 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004945 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004946 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004947 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004948 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004949 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004950 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004951
4952 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004953 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4954 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4955 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4956 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4957 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004958
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004959 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004960 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4961 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4962 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004963 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004964 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4965 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004966 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4967 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004968 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4969 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004970 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004971 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004972 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004973 const std::string src_invalid_layout_vuid =
4974 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4975 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4976 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004977 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004978 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4979 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004980 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004981 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4982 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004983 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004984 "vkCmdCopyImageToBuffer()",
4985 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004986 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4987 "vkCmdCopyImageToBuffer()", "imageSubresource",
4988 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4989 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4990 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4991 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004992 }
4993 return skip;
4994}
4995
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004996void PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4997 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4998 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4999 auto cb_node = GetCBNode(device_data, commandBuffer);
5000 auto src_image_state = GetImageState(device_data, srcImage);
5001 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
5002
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005003 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005004 for (uint32_t i = 0; i < regionCount; ++i) {
5005 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005006 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005007 // Update bindings between buffer/image and cmd buffer
5008 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07005009 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005010}
5011
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005012bool PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5013 VkImageLayout dstImageLayout, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5014 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
5015 auto cb_node = GetCBNode(device_data, commandBuffer);
5016 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
5017 auto dst_image_state = GetImageState(device_data, dstImage);
5018 const debug_report_data *report_data = device_data->report_data;
5019
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005020 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
5021
5022 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07005023 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005024
5025 // Command pool must support graphics, compute, or transfer operations
5026 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
5027 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
5028 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5029 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 -06005030 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005031 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005032 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005033 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005034 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005035 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005036 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005037 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005038 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005039 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
5040 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
5041 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5042 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
5043 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06005044 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005045 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5046 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5047 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
5048 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5049 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04005050 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
5051 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005052 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
5053 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005054 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06005055 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005056 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07005057 const std::string dst_invalid_layout_vuid =
5058 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
5059 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5060 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005061 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07005062 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
5063 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06005064 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005065 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5066 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005067 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06005068 "vkCmdCopyBufferToImage()",
5069 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07005070 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
5071 "vkCmdCopyBufferToImage()", "imageSubresource",
5072 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5073 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
5074 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5075 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005076 }
5077 return skip;
5078}
5079
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005080void PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5081 VkImageLayout dstImageLayout, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5082 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
5083 auto cb_node = GetCBNode(device_data, commandBuffer);
5084 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
5085 auto dst_image_state = GetImageState(device_data, dstImage);
5086
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005087 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005088 for (uint32_t i = 0; i < regionCount; ++i) {
5089 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005090 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07005091 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005092 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005093}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005094
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07005095bool PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5096 VkSubresourceLayout *pLayout) {
5097 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
5098 const auto report_data = device_data->report_data;
Mike Weiblen672b58b2017-02-21 14:32:53 -07005099 bool skip = false;
5100 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5101
Dave Houlton1d960ff2018-01-19 12:17:05 -07005102 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005103 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5104 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5105 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005106 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 -06005107 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005108 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005109 }
5110
5111 IMAGE_STATE *image_entry = GetImageState(device_data, image);
5112 if (!image_entry) {
5113 return skip;
5114 }
5115
Dave Houlton1d960ff2018-01-19 12:17:05 -07005116 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005117 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005118 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5119 "VUID-vkGetImageSubresourceLayout-image-00996",
5120 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005121 }
5122
Dave Houlton1d960ff2018-01-19 12:17:05 -07005123 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005124 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005125 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5126 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5127 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5128 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005129 }
5130
Dave Houlton1d960ff2018-01-19 12:17:05 -07005131 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005132 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005133 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5134 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5135 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5136 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005137 }
5138
Dave Houlton1d960ff2018-01-19 12:17:05 -07005139 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005140 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005141 if (FormatIsMultiplane(img_format)) {
5142 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Dave Houltond8ed0212018-05-16 17:18:24 -06005143 std::string vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005144 if (FormatPlaneCount(img_format) > 2u) {
5145 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005146 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005147 }
5148 if (sub_aspect != (sub_aspect & allowed_flags)) {
5149 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 -06005150 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005151 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005152 ") must be a single-plane specifier flag.",
5153 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005154 }
5155 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005156 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005157 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005158 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005159 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005160 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005161 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005162 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005163 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005164 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 -06005165 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005166 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005167 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005168 }
5169 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005170
5171 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
5172 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
5173 }
5174
Mike Weiblen672b58b2017-02-21 14:32:53 -07005175 return skip;
5176}