blob: e8e26958f7f3ea0ad8ff6cf069ee31520adb2cf6 [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;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600683 const char *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
Mark Lobodzinskibf0400a2019-01-30 16:32:31 -0700925void RecordBarriersQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
926 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
927 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600928 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,
Jeff Bolzfdd0d852019-02-03 21:55:12 -06001132 const char *caller, const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001133 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001134 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001135 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001136
1137 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1138 uint32_t layer = i + subLayers.baseArrayLayer;
1139 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1140 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001141 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1142 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001143 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001144 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1145 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1146 "%s: Cannot use image 0x%" PRIx64
1147 " (layer=%u mip=%u) with specific layout %s that doesn't match the actual current layout %s.",
1148 caller, HandleToUint64(image), layer, subLayers.mipLevel, string_VkImageLayout(explicit_layout),
1149 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001150 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001151 }
1152 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001153 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1154 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1155 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001156 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1157 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001158 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001159 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001160 kVUID_Core_DrawState_InvalidImageLayout,
Petr Kraus13c98a62017-12-09 00:22:39 +01001161 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
1162 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001163 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001164 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001165 if (image_state->shared_presentable) {
1166 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001167 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1168 layout_invalid_msg_code,
1169 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1170 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001171 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001172 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001173 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001174 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001175 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 -07001176 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001177 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1178 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001179 }
1180 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001181 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001182}
1183
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001184void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
1185 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001186 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001187 if (!renderPass) return;
1188
Tobias Hectorbbb12282018-10-22 15:17:59 +01001189 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001190 if (framebuffer_state) {
1191 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -06001192 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
1193 if (view_state) {
1194 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
1195 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001196 }
1197 }
1198}
Dave Houltone19e20d2018-02-02 16:32:41 -07001199
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001200#ifdef VK_USE_PLATFORM_ANDROID_KHR
1201// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1202// This could also move into a seperate core_validation_android.cpp file... ?
1203
1204//
1205// AHB-specific validation within non-AHB APIs
1206//
1207bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1208 const VkImageCreateInfo *create_info) {
1209 bool skip = false;
1210
1211 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1212 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001213 if (0 != ext_fmt_android->externalFormat) {
1214 if (VK_FORMAT_UNDEFINED != create_info->format) {
1215 skip |=
1216 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1217 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001218 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001219 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1220 }
1221
1222 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1223 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1224 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001225 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001226 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1227 }
1228
1229 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1230 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1231 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001232 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001233 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1234 }
1235
1236 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1237 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1238 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001239 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001240 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1241 }
1242 }
1243
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001244 auto ahb_formats = GetAHBExternalFormatsSet(device_data);
1245 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1246 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1247 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001248 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001249 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1250 }
1251 }
1252
Dave Houltond9611312018-11-19 17:03:36 -07001253 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001254 if (VK_FORMAT_UNDEFINED == create_info->format) {
1255 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1256 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001257 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001258 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1259 }
1260 }
1261
1262 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1263 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1264 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001265 skip |=
1266 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1267 "VUID-VkImageCreateInfo-pNext-02393",
1268 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1269 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1270 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001271 }
1272
1273 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1274 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1275 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001276 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001277 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1278 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1279 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1280 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001281 }
1282
1283 return skip;
1284}
1285
1286void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
1287 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1288 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1289 is_node->imported_ahb = true;
1290 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001291 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001292 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001293 is_node->has_ahb_format = true;
1294 is_node->ahb_format = ext_fmt_android->externalFormat;
1295 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001296}
1297
1298bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
1299 bool skip = false;
1300 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houltond3e046d2018-11-28 13:08:09 -07001301 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
1302
1303 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001304 if (VK_FORMAT_UNDEFINED != create_info->format) {
1305 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1306 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1307 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1308 "format member is %s.",
1309 string_VkFormat(create_info->format));
1310 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001311
Dave Houltond9611312018-11-19 17:03:36 -07001312 // Chain must include a compatible ycbcr conversion
1313 bool conv_found = false;
1314 uint64_t external_format = 0;
1315 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1316 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001317 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
1318 auto fmap = GetYcbcrConversionFormatMap(device_data);
Dave Houltond9611312018-11-19 17:03:36 -07001319 if (fmap->find(conv_handle) != fmap->end()) {
1320 conv_found = true;
1321 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001322 }
Dave Houltond9611312018-11-19 17:03:36 -07001323 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001324 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001325 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 -07001326 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1327 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1328 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1329 }
1330
1331 // Errors in create_info swizzles
1332 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1333 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1334 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1335 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1336 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1337 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1338 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1339 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001340 }
1341 }
Dave Houltond9611312018-11-19 17:03:36 -07001342
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001343 return skip;
1344}
1345
1346bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
1347 bool skip = false;
1348 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1349
1350 IMAGE_STATE *image_state = GetImageState(device_data, image);
1351 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1352 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1353 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001354 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001355 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1356 "bound to memory.");
1357 }
1358 return skip;
1359}
1360
1361#else
1362
1363bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1364 const VkImageCreateInfo *create_info) {
1365 return false;
1366}
1367
1368void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
1369
1370bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
1371
1372bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
1373
1374#endif // VK_USE_PLATFORM_ANDROID_KHR
1375
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001376bool PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
1377 VkImage *pImage) {
1378 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), core_validation::layer_data_map);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001379 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001380 const debug_report_data *report_data = GetReportData(device_data);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001381
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001382 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1383 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1384 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1385 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1386 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1387 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001388 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001389 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001390 }
1391
Dave Houlton130c0212018-01-29 13:39:56 -07001392 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001393 skip |= log_msg(
1394 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1395 "VUID-VkImageCreateInfo-flags-00949",
1396 "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 -07001397 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001398
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07001399 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001400 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1401 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1402 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001403 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 +00001404 "VUID-VkImageCreateInfo-usage-00964",
1405 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1406 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001407 }
1408
1409 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001410 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001411 "VUID-VkImageCreateInfo-usage-00965",
1412 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1413 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001414 }
1415
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001416 VkImageFormatProperties format_limits = {};
1417 VkResult res = GetPDImageFormatProperties(device_data, pCreateInfo, &format_limits);
1418 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1419 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1420 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1421 string_VkFormat(pCreateInfo->format));
1422 } else {
1423 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1424 const char *format_string = string_VkFormat(pCreateInfo->format);
1425 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1426 "VUID-VkImageCreateInfo-mipLevels-02255",
1427 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1428 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1429 }
Dave Houlton130c0212018-01-29 13:39:56 -07001430
Dave Houltona585d132019-01-18 13:05:42 -07001431 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1432 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1433 (uint64_t)pCreateInfo->samples;
1434 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001435
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001436 // Round up to imageGranularity boundary
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07001437 VkDeviceSize imageGranularity = GetPDProperties(device_data)->limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001438 uint64_t ig_mask = imageGranularity - 1;
1439 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001440
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001441 if (total_size > format_limits.maxResourceSize) {
1442 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1443 kVUID_Core_Image_InvalidFormatLimitsViolation,
1444 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1445 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1446 total_size, format_limits.maxResourceSize);
1447 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001448
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001449 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1450 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1451 "VUID-VkImageCreateInfo-arrayLayers-02256",
1452 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1453 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1454 }
1455
1456 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1457 skip |=
1458 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1459 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001460 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001461 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001462 }
1463
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06001464 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) &&
1465 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001466 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 -06001467 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001468 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1469 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001470 }
1471
Lenny Komowb79f04a2017-09-18 17:07:00 -06001472 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1473 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1474 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1475 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1476 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001477 skip |=
1478 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1479 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1480 "format must be block, ETC or ASTC compressed, but is %s",
1481 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001482 }
1483 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1484 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001485 skip |=
1486 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1487 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1488 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001489 }
1490 }
1491 }
1492
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001493 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
1494 skip |= core_validation::ValidateQueueFamilies(
1495 device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1496 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1497 "VUID-VkImageCreateInfo-sharingMode-01420", false);
1498 }
1499
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001500 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001501}
1502
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001503void PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001504 VkImage *pImage, VkResult result) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001505 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), core_validation::layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001506 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001507 IMAGE_LAYOUT_NODE image_state;
1508 image_state.layout = pCreateInfo->initialLayout;
1509 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001510 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
1511 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1512 RecordCreateImageANDROID(pCreateInfo, is_node);
1513 }
1514 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001515 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001516 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1517 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001518}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001519
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001520bool PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1521 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
1522 IMAGE_STATE *image_state = core_validation::GetImageState(device_data, image);
1523 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001524 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001525 if (image_state) {
1526 skip |= core_validation::ValidateObjectNotInUse(device_data, image_state, obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001527 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001528 }
1529 return skip;
1530}
1531
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001532void PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1533 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
1534 IMAGE_STATE *image_state = core_validation::GetImageState(device_data, image);
1535 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001536 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001537 // Clean up memory mapping, bindings and range references for image
1538 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001539 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001540 if (mem_info) {
1541 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1542 }
1543 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001544 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001545 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001546 // Remove image from imageMap
1547 core_validation::GetImageMap(device_data)->erase(image);
1548 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1549 core_validation::GetImageSubresourceMap(device_data);
1550
1551 const auto &sub_entry = imageSubresourceMap->find(image);
1552 if (sub_entry != imageSubresourceMap->end()) {
1553 for (const auto &pair : sub_entry->second) {
1554 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1555 }
1556 imageSubresourceMap->erase(sub_entry);
1557 }
1558}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001559
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001560bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001561 bool skip = false;
1562 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1563
1564 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1565 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1566 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 -06001567 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001568 }
1569
Dave Houlton1d2022c2017-03-29 11:43:58 -06001570 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001571 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1572 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 -06001573 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001574 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001575 char const str[] = "vkCmdClearColorImage called with compressed image.";
1576 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 -06001577 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001578 }
1579
1580 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1581 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1582 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 -06001583 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001584 }
1585 return skip;
1586}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001587
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001588uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1589 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1590 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001591 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001592 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001593 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001594 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001595}
1596
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001597uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1598 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1599 uint32_t array_layer_count = range->layerCount;
1600 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1601 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001602 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001603 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001604}
1605
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001606bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001607 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1608 bool skip = false;
1609 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1610
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001611 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1612 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001613
1614 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1615 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001616 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1617 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001618 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 -06001619 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001620 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1621 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001622 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001623 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001624 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001625 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 -06001626 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001627 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1628 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001629
1630 } else {
1631 if (image_state->shared_presentable) {
1632 skip |= log_msg(
1633 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001634 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001635 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1636 string_VkImageLayout(dest_image_layout));
1637 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001638 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001639 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001640 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001641 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001642 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643 } else {
1644 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1645 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001646 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 -06001647 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001648 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1649 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001650 }
1651 }
1652
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001653 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1654 uint32_t level = level_index + range.baseMipLevel;
1655 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1656 uint32_t layer = layer_index + range.baseArrayLayer;
1657 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001658 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001659 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001660 if (node.layout != dest_image_layout) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001661 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001662 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001663 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001664 } else {
1665 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1666 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001667 skip |=
1668 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1669 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1670 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001671 }
1672 }
1673 }
1674 }
1675
1676 return skip;
1677}
1678
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001679void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1680 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001681 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1682 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1683 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001684
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001685 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1686 uint32_t level = level_index + range.baseMipLevel;
1687 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1688 uint32_t layer = layer_index + range.baseArrayLayer;
1689 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001690 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001691 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1692 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 -07001693 }
1694 }
1695 }
1696}
1697
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001698bool PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1699 const VkClearColorValue *pColor, uint32_t rangeCount,
1700 const VkImageSubresourceRange *pRanges) {
1701 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1702
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001703 bool skip = false;
1704 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001705 auto cb_node = GetCBNode(device_data, commandBuffer);
1706 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001707 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001708 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearColorImage()",
1709 "VUID-vkCmdClearColorImage-image-00003");
1710 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001711 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001712 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
1713 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1714 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
1715 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993",
1716 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001717 }
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001718 skip |= InsideRenderPass(device_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001719 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001720 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001721 skip |= ValidateCmdClearColorSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
1722 skip |= ValidateImageAttributes(device_data, image_state, pRanges[i]);
1723 skip |= VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001724 }
1725 }
1726 return skip;
1727}
1728
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001729void PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1730 const VkClearColorValue *pColor, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1731 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1732
1733 auto cb_node = GetCBNode(device_data, commandBuffer);
1734 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001735 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001736 AddCommandBufferBindingImage(device_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001737 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001738 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001739 }
1740 }
1741}
1742
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001743bool PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1744 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001745 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001746 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001747 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001748 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1749
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001750 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001751 auto cb_node = GetCBNode(device_data, commandBuffer);
1752 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001753 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001754 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1755 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001756 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001757 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001758 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001759 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1760 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001761 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1762 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001763 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001764 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001765 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001766 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001767 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001768 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001769 skip |=
1770 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001771 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001772 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1773 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001774 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001775 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1776 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001777 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 -06001778 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001779 }
1780 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001781 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001782 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001783 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-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001785 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001786 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1787 char const str[] =
1788 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1789 "set.";
1790 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 -06001791 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001792 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001793 }
1794 return skip;
1795}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001796
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001797void PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1798 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1799 const VkImageSubresourceRange *pRanges) {
1800 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1801
1802 auto cb_node = GetCBNode(device_data, commandBuffer);
1803 auto image_state = GetImageState(device_data, image);
1804 if (cb_node && image_state) {
1805 AddCommandBufferBindingImage(device_data, cb_node, image_state);
1806 for (uint32_t i = 0; i < rangeCount; ++i) {
1807 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
1808 }
1809 }
1810}
1811
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001812// Returns true if [x, xoffset] and [y, yoffset] overlap
1813static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1814 bool result = false;
1815 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1816 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1817
1818 if (intersection_max > intersection_min) {
1819 result = true;
1820 }
1821 return result;
1822}
1823
Dave Houltonc991cc92018-03-06 11:08:51 -07001824// Returns true if source area of first copy region intersects dest area of second region
1825// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1826static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001827 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001828
Dave Houltonc991cc92018-03-06 11:08:51 -07001829 // Separate planes within a multiplane image cannot intersect
1830 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001831 return result;
1832 }
1833
Dave Houltonc991cc92018-03-06 11:08:51 -07001834 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1835 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1836 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001837 result = true;
1838 switch (type) {
1839 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001840 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001841 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001842 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001843 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001844 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001845 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001846 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001847 break;
1848 default:
1849 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1850 assert(false);
1851 }
1852 }
1853 return result;
1854}
1855
Dave Houltonfc1a4052017-04-27 14:32:45 -06001856// Returns non-zero if offset and extent exceed image extents
1857static const uint32_t x_bit = 1;
1858static const uint32_t y_bit = 2;
1859static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001860static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001861 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001862 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001863 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1864 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001865 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001866 }
1867 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1868 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001869 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001870 }
1871 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1872 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001873 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001874 }
1875 return result;
1876}
1877
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001878// Test if two VkExtent3D structs are equivalent
1879static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1880 bool result = true;
1881 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1882 (extent->depth != other_extent->depth)) {
1883 result = false;
1884 }
1885 return result;
1886}
1887
Dave Houltonee281a52017-12-08 13:51:02 -07001888// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1889// Destination image texel extents must be adjusted by block size for the dest validation checks
1890VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1891 VkExtent3D adjusted_extent = extent;
1892 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001893 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001894 adjusted_extent.width /= block_size.width;
1895 adjusted_extent.height /= block_size.height;
1896 adjusted_extent.depth /= block_size.depth;
1897 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001898 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001899 adjusted_extent.width *= block_size.width;
1900 adjusted_extent.height *= block_size.height;
1901 adjusted_extent.depth *= block_size.depth;
1902 }
1903 return adjusted_extent;
1904}
1905
Dave Houlton6f9059e2017-05-02 17:15:13 -06001906// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001907static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1908 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001909
1910 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001911 if (mip >= img->createInfo.mipLevels) {
1912 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001913 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001914
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001915 // 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 -06001916 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001917
Dave Houltone48cd112019-01-03 17:01:18 -07001918 // If multi-plane, adjust per-plane extent
1919 if (FormatIsMultiplane(img->createInfo.format)) {
1920 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1921 extent.width /= divisors.width;
1922 extent.height /= divisors.height;
1923 }
1924
Jeff Bolzef40fec2018-09-01 22:04:34 -05001925 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1926 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001927 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001928 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1929 } else {
1930 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1931 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1932 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1933 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001934
Dave Houlton6f9059e2017-05-02 17:15:13 -06001935 // Image arrays have an effective z extent that isn't diminished by mip level
1936 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001937 extent.depth = img->createInfo.arrayLayers;
1938 }
1939
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001940 return extent;
1941}
1942
1943// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001944static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001945 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1946}
1947
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001948// Test if the extent argument has any dimensions set to 0.
1949static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1950 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1951}
1952
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001953// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1954static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1955 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1956 VkExtent3D granularity = {0, 0, 0};
1957 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1958 if (pPool) {
1959 granularity =
1960 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001961 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001962 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001963 granularity.width *= block_size.width;
1964 granularity.height *= block_size.height;
1965 }
1966 }
1967 return granularity;
1968}
1969
1970// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1971static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1972 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001973 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1974 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001975 valid = false;
1976 }
1977 return valid;
1978}
1979
1980// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1981static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001982 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001983 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001984 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1985 bool skip = false;
1986 VkExtent3D offset_extent = {};
1987 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1988 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1989 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001990 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001991 // 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 -07001992 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001993 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 -04001994 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001995 "%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 "
1996 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001997 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001998 }
1999 } else {
2000 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2001 // integer multiples of the image transfer granularity.
2002 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002003 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 -04002004 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002005 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2006 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002007 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2008 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002009 }
2010 }
2011 return skip;
2012}
2013
2014// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
2015static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
2016 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002017 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002018 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002019 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2020 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002021 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002022 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2023 // subresource extent.
2024 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002025 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 -04002026 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002027 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2028 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2029 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2030 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002031 }
2032 } else {
2033 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2034 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2035 // subresource extent dimensions.
2036 VkExtent3D offset_extent_sum = {};
2037 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2038 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2039 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002040 bool x_ok = true;
2041 bool y_ok = true;
2042 bool z_ok = true;
2043 switch (image_type) {
2044 case VK_IMAGE_TYPE_3D:
2045 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2046 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002047 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002048 case VK_IMAGE_TYPE_2D:
2049 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2050 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002051 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002052 case VK_IMAGE_TYPE_1D:
2053 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2054 (subresource_extent->width == offset_extent_sum.width));
2055 break;
2056 default:
2057 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2058 assert(false);
2059 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002060 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002061 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 -04002062 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002063 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2064 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2065 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2066 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2067 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2068 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002069 }
2070 }
2071 return skip;
2072}
2073
Cort Strattonff1542a2018-05-27 10:49:28 -07002074bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002075 const uint32_t i, const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002076 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2077 bool skip = false;
2078 if (mip_level >= img->createInfo.mipLevels) {
2079 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2080 HandleToUint64(cb_node->commandBuffer), vuid,
2081 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
2082 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
2083 }
2084 return skip;
2085}
2086
2087bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2088 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002089 const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002090 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2091 bool skip = false;
2092 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2093 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2094 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2095 HandleToUint64(cb_node->commandBuffer), vuid,
2096 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2097 "%u, but provided image %" PRIx64 " has %u array layers.",
2098 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
2099 }
2100 return skip;
2101}
2102
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002103// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002104bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2105 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002106 const uint32_t i, const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002107 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002108 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2109 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2110 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2111 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2112 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002113 return skip;
2114}
2115
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002116// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002117bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002118 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2119 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002120 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002121 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002122 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002123 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2124 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002125 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002126 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002127 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002128 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002129
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002130 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002131 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002132 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2133 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002134 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002135 const VkExtent3D dest_effective_extent =
2136 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002137 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002138 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002139 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002140 return skip;
2141}
2142
Dave Houlton6f9059e2017-05-02 17:15:13 -06002143// Validate contents of a VkImageCopy struct
2144bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
2145 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
2146 bool skip = false;
2147
2148 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002149 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002150
2151 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002152 const VkExtent3D src_copy_extent = region.extent;
2153 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002154 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2155
Dave Houlton6f9059e2017-05-02 17:15:13 -06002156 bool slice_override = false;
2157 uint32_t depth_slices = 0;
2158
2159 // Special case for copying between a 1D/2D array and a 3D image
2160 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2161 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002162 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002163 slice_override = (depth_slices != 1);
2164 } 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 -07002165 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002166 slice_override = (depth_slices != 1);
2167 }
2168
2169 // Do all checks on source image
2170 //
2171 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002172 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2173 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 -06002174 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002175 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002176 "be 0 and 1, respectively.",
2177 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002178 }
2179 }
2180
Dave Houlton533be9f2018-03-26 17:08:30 -06002181 // VUID-VkImageCopy-srcImage-01785
2182 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2183 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 -06002184 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002185 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002186 "these must be 0 and 1, respectively.",
2187 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002188 }
2189
Dave Houlton533be9f2018-03-26 17:08:30 -06002190 // VUID-VkImageCopy-srcImage-01787
2191 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2192 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002193 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002194 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2195 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002196 }
2197
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002198 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002199 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002200 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002201 skip |=
2202 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002203 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002204 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002205 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2206 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002207 }
2208 }
2209 } else { // Pre maint 1
2210 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002211 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002212 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 -06002213 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002214 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2215 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002216 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2217 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002218 }
2219 }
2220 }
2221
Dave Houltonc991cc92018-03-06 11:08:51 -07002222 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2223 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
2224 if (FormatIsCompressed(src_state->createInfo.format) ||
2225 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002226 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002228 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2229 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2230 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002231 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002232 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 -07002233 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002234 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002235 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002236 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002237 }
2238
Dave Houlton94a00372017-12-14 15:08:47 -07002239 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002240 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2241 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002242 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002243 skip |=
2244 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002245 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002246 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002247 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002248 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002249 }
2250
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002251 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002252 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2253 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002254 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255 skip |=
2256 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002257 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002258 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002259 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002260 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002261 }
2262
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002263 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002264 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2265 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002266 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 skip |=
2268 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002269 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002271 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002272 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002273 }
2274 } // Compressed
2275
2276 // Do all checks on dest image
2277 //
2278 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002279 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002280 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 -06002281 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002282 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002283 "these must be 0 and 1, respectively.",
2284 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002285 }
2286 }
2287
Dave Houlton533be9f2018-03-26 17:08:30 -06002288 // VUID-VkImageCopy-dstImage-01786
2289 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2290 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 -06002291 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002292 "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 -06002293 "and 1, respectively.",
2294 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002295 }
2296
2297 // VUID-VkImageCopy-dstImage-01788
2298 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2299 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002300 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002301 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2302 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303 }
2304
2305 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002306 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002307 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 -06002308 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002309 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002310 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2311 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002312 }
2313 }
2314 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002315 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002316 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002317 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002318 skip |=
2319 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002320 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002321 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002322 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2323 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002324 }
2325 }
2326 } else { // Pre maint 1
2327 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002328 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002329 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 -06002330 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002331 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2332 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002333 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2334 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002335 }
2336 }
2337 }
2338
Dave Houltonc991cc92018-03-06 11:08:51 -07002339 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2340 if (FormatIsCompressed(dst_state->createInfo.format) ||
2341 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002342 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002343
2344 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002345 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2346 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2347 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002348 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002349 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 -07002350 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002351 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002352 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002353 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002354 }
2355
Dave Houlton94a00372017-12-14 15:08:47 -07002356 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002357 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2358 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002359 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002360 skip |=
2361 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002362 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002363 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002364 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002365 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002366 }
2367
Dave Houltonee281a52017-12-08 13:51:02 -07002368 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2369 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2370 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002371 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002372 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 -07002373 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002374 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2375 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002376 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002377 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002378 }
2379
Dave Houltonee281a52017-12-08 13:51:02 -07002380 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2381 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2382 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002383 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002384 skip |=
2385 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002386 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002387 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002388 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002389 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002390 }
2391 } // Compressed
2392 }
2393 return skip;
2394}
2395
Dave Houltonc991cc92018-03-06 11:08:51 -07002396// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2397bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2398 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2399 bool skip = false;
2400 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2401
2402 // Neither image is multiplane
2403 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2404 // If neither image is multi-plane the aspectMask member of src and dst must match
2405 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2406 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002407 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002408 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2409 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 -06002410 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002411 }
2412 } else {
2413 // Source image multiplane checks
2414 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2415 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2416 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_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 2-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-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002421 }
2422 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2423 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2424 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002425 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002426 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 -06002427 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002428 }
2429 // Single-plane to multi-plane
2430 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2431 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2432 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002433 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002434 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 -06002435 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002436 }
2437
2438 // Dest image multiplane checks
2439 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2440 aspect = region.dstSubresource.aspectMask;
2441 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_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 2-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-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002446 }
2447 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2448 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2449 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002450 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002451 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 -06002452 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002453 }
2454 // Multi-plane to single-plane
2455 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2456 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2457 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002458 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002459 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 -06002460 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002461 }
2462 }
2463
2464 return skip;
2465}
2466
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002467bool PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2468 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageCopy *pRegions) {
2469 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2470 auto cb_node = GetCBNode(device_data, commandBuffer);
2471 auto src_image_state = GetImageState(device_data, srcImage);
2472 auto dst_image_state = GetImageState(device_data, dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002473 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002474 const debug_report_data *report_data = device_data->report_data;
2475
2476 skip = ValidateImageCopyData(device_data, report_data, regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002477
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002478 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2479
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002480 for (uint32_t i = 0; i < regionCount; i++) {
2481 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002482
2483 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2484 VkExtent3D src_copy_extent = region.extent;
2485 VkExtent3D dst_copy_extent =
2486 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2487
Dave Houlton6f9059e2017-05-02 17:15:13 -06002488 bool slice_override = false;
2489 uint32_t depth_slices = 0;
2490
2491 // Special case for copying between a 1D/2D array and a 3D image
2492 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2493 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2494 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002495 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002496 slice_override = (depth_slices != 1);
2497 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2498 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002499 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002500 slice_override = (depth_slices != 1);
2501 }
2502
Cort Strattond619a302018-05-17 19:46:32 -07002503 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2504 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002505 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2506 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2507 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2508 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2509 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2510 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2511 "VUID-vkCmdCopyImage-srcSubresource-01698");
2512 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2513 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2514 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002515
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002516 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002517 // No chance of mismatch if we're overriding depth slice count
2518 if (!slice_override) {
2519 // The number of depth slices in srcSubresource and dstSubresource must match
2520 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2521 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002522 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2523 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002524 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002525 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2526 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002527 if (src_slices != dst_slices) {
2528 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002529 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002530 << "] do not match";
2531 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 -06002532 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002533 }
2534 }
2535 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002536 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002537 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002538 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002539 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002540 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002541 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002542 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002543 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002544 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002545
Dave Houltonc991cc92018-03-06 11:08:51 -07002546 // Do multiplane-specific checks, if extension enabled
2547 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2548 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2549 }
2550
Dave Houltonf5217612018-02-02 16:18:52 -07002551 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2552 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2553 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002554 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002555 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 -06002556 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002557 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002558 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002559
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002560 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002561 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002562 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002563 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002564 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2565 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 -06002566 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002567 }
2568
2569 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002570 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002571 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002572 ss << "vkCmdCopyImage(): pRegion[" << i
2573 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002574 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002575 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002576 }
2577
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002578 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2579 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2580 // 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 -07002581 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2582 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002583 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002584 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002585 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2586 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2587 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002588 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 -06002589 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002590 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002591
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002592 // 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 -07002593 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2594 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002595 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002596 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002597 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2598 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2599 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002600 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 -06002601 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002602 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002603 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002604
Dave Houltonfc1a4052017-04-27 14:32:45 -06002605 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002606 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2607 if (slice_override) src_copy_extent.depth = depth_slices;
2608 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002609 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002610 skip |=
2611 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2612 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2613 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2614 "width [%1d].",
2615 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002616 }
2617
2618 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002619 skip |=
2620 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2621 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2622 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2623 "height [%1d].",
2624 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002625 }
2626 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002627 skip |=
2628 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2629 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2630 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2631 "depth [%1d].",
2632 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002633 }
2634
Dave Houltonee281a52017-12-08 13:51:02 -07002635 // Adjust dest extent if necessary
2636 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2637 if (slice_override) dst_copy_extent.depth = depth_slices;
2638
2639 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002640 if (extent_check & x_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-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002643 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002644 "width [%1d].",
2645 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002646 }
2647 if (extent_check & y_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-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002650 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002651 "height [%1d].",
2652 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002653 }
2654 if (extent_check & z_bit) {
2655 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 -06002656 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002657 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002658 "depth [%1d].",
2659 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002660 }
2661
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2663 // must not overlap in memory
2664 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002665 for (uint32_t j = 0; j < regionCount; j++) {
2666 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002667 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002668 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002669 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002670 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 -06002671 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002672 }
2673 }
2674 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002675 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002676
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002677 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2678 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2679 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002680 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002681 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2682 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002683 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 -06002684 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002685 }
2686 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002687 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002688 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2689 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 -06002690 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002691 }
2692 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002693
Dave Houlton33c22b72017-02-28 13:16:02 -07002694 // Source and dest image sample counts must match
2695 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2696 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2697 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 -06002698 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002699 }
2700
Dave Houltond8ed0212018-05-16 17:18:24 -06002701 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2702 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002703 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002704 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2705 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2706 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2707 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002708 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002709 skip |=
2710 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002711 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002712 skip |=
2713 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002714 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002715 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002716 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002717 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2718 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002719 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002720 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002721 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002722 const char *invalid_src_layout_vuid =
Cort Stratton7df30962018-05-17 19:45:57 -07002723 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2724 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2725 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002726 const char *invalid_dst_layout_vuid =
Cort Stratton7df30962018-05-17 19:45:57 -07002727 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2728 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2729 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002730 for (uint32_t i = 0; i < regionCount; ++i) {
2731 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002732 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2733 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002734 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002735 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2736 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002737 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002738 &pRegions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002739 }
2740
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002741 return skip;
2742}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002743
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002744void PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2745 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageCopy *pRegions) {
2746 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2747 auto cb_node = GetCBNode(device_data, commandBuffer);
2748 auto src_image_state = GetImageState(device_data, srcImage);
2749 auto dst_image_state = GetImageState(device_data, dstImage);
2750
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002751 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002752 for (uint32_t i = 0; i < regionCount; ++i) {
2753 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2754 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002755 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002756 // Update bindings between images and cmd buffer
2757 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2758 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002759}
2760
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002761// Returns true if sub_rect is entirely contained within rect
2762static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2763 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2764 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2765 return false;
2766 return true;
2767}
2768
John Zulauf3a548ef2019-02-01 16:14:07 -07002769static bool ValidateClearAttachementExtent(const layer_data *device_data, VkCommandBuffer command_buffer, uint32_t attachment_index,
2770 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2771 uint32_t rect_count, const VkClearRect *clear_rects) {
2772 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002773 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2774 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
2775 image_view_state = GetImageViewState(device_data, framebuffer->createInfo.pAttachments[fb_attachment]);
2776 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002777
2778 for (uint32_t j = 0; j < rect_count; j++) {
2779 if (!ContainsRect(render_area, clear_rects[j].rect)) {
2780 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2781 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2782 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2783 "the current render pass instance.",
2784 j);
2785 }
2786
2787 if (image_view_state) {
2788 // The layers specified by a given element of pRects must be contained within every attachment that
2789 // pAttachments refers to
2790 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2791 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2792 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
2793 skip |=
2794 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2795 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2796 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2797 "of pAttachment[%d].",
2798 j, attachment_index);
2799 }
2800 }
2801 }
2802 return skip;
2803}
2804
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002805bool PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002806 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002807 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2808
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002809 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002810 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002811
2812 bool skip = false;
2813 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002814 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002815 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002816 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002817 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002818 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002819 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2820 // 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 -07002821 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2822 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002823 skip |= log_msg(
2824 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002825 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002826 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2827 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2828 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002829 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002830 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002831 }
2832
2833 // Validate that attachment is in reference list of active subpass
2834 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002835 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002836 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002837 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002838 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002839 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2840 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002841
John Zulauf3a548ef2019-02-01 16:14:07 -07002842 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2843 auto clear_desc = &pAttachments[attachment_index];
2844 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002845
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002846 if (0 == clear_desc->aspectMask) {
2847 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 -06002848 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002849 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2850 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 -06002851 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002852 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002853 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2854 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2855 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2856 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
2857 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2858 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2859 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2860 "and not a valid attachment for render pass 0x%" PRIx64
2861 " attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2862 attachment_index, clear_desc->colorAttachment,
2863 HandleToUint64(cb_node->activeRenderPass->renderPass), cb_node->activeSubpass,
2864 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2865 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2866 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002867 } else {
John Zulauff2582972019-02-09 14:53:30 -07002868 skip |= log_msg(
2869 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2870 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2871 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass 0x%" PRIx64
2872 " subpass %u. colorAttachmentCount=%u",
2873 attachment_index, clear_desc->colorAttachment, HandleToUint64(cb_node->activeRenderPass->renderPass),
2874 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002875 }
John Zulauff2582972019-02-09 14:53:30 -07002876 fb_attachment = color_attachment;
2877
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002878 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2879 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2880 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002881 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002882 skip |=
2883 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2884 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002885 }
2886 } else { // Must be depth and/or stencil
2887 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2888 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002889 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002890 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
John Zulauf3a548ef2019-02-01 16:14:07 -07002891 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2892 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002893 }
2894 if (!subpass_desc->pDepthStencilAttachment ||
2895 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2896 skip |= log_msg(
2897 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002898 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002899 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002900 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002901 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002902 }
2903 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002904 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2905 skip |= ValidateClearAttachementExtent(device_data, commandBuffer, attachment_index, framebuffer, fb_attachment,
2906 render_area, rectCount, pRects);
2907 } else {
2908 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2909 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2910 if (!clear_rect_copy) {
2911 // We need a copy of the clear rectangles that will persist until the last lambda executes
2912 // but we want to create it as lazily as possible
2913 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002914 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002915
2916 auto val_fn = [device_data, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
2917 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2918 assert(rectCount == clear_rect_copy->size());
2919 auto framebuffer = GetFramebufferState(device_data, fb);
2920 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2921 bool skip = false;
2922 skip = ValidateClearAttachementExtent(device_data, commandBuffer, attachment_index, framebuffer, fb_attachment,
2923 render_area, rectCount, clear_rect_copy->data());
2924 return skip;
2925 };
2926 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002927 }
2928 }
2929 }
2930 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002931}
2932
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002933bool PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
2934 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageResolve *pRegions) {
2935 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2936 auto cb_node = GetCBNode(device_data, commandBuffer);
2937 auto src_image_state = GetImageState(device_data, srcImage);
2938 auto dst_image_state = GetImageState(device_data, dstImage);
2939
2940 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002941 bool skip = false;
2942 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002943 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2944 "VUID-vkCmdResolveImage-srcImage-00256");
2945 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2946 "VUID-vkCmdResolveImage-dstImage-00258");
2947 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2948 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002949 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002950 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002951 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002952 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2953 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002954
Cort Stratton7df30962018-05-17 19:45:57 -07002955 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002956 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable &&
2957 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2958 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2959 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2960 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable &&
2961 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2962 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2963 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002964 // For each region, the number of layers in the image subresource should not be zero
2965 // For each region, src and dest image aspect must be color only
2966 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002967 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2968 "srcSubresource", i);
2969 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2970 "dstSubresource", i);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002971 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002972 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2973 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002974 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002975 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2976 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002977 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2978 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2979 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2980 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2981 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2982 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2983 "VUID-vkCmdResolveImage-srcSubresource-01711");
2984 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2985 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2986 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002987
2988 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002989 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2990 skip |= log_msg(
2991 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002992 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002993 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002994 }
Cort Stratton7df30962018-05-17 19:45:57 -07002995 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002996 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2997 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2998 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002999 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003000 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 -06003001 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003002 }
3003 }
3004
3005 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3006 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003007 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 -06003008 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003009 }
3010 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3011 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003012 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 -06003013 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003014 }
3015 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3016 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3017 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 -06003018 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003019 }
3020 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3021 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3022 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 -06003023 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003024 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003025 } else {
3026 assert(0);
3027 }
3028 return skip;
3029}
3030
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003031void PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
3032 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageResolve *pRegions) {
3033 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
3034 auto cb_node = GetCBNode(device_data, commandBuffer);
3035 auto src_image_state = GetImageState(device_data, srcImage);
3036 auto dst_image_state = GetImageState(device_data, dstImage);
3037
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003038 // Update bindings between images and cmd buffer
3039 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3040 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003041}
3042
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003043bool PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
3044 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3045 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
3046 auto cb_node = GetCBNode(device_data, commandBuffer);
3047 auto src_image_state = GetImageState(device_data, srcImage);
3048 auto dst_image_state = GetImageState(device_data, dstImage);
3049 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003050
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003051 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003052 if (cb_node) {
3053 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3054 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003055 if (cb_node && src_image_state && dst_image_state) {
3056 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003057 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003058 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003059 "VUID-vkCmdBlitImage-dstImage-00234");
3060 skip |=
3061 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3062 skip |=
3063 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
3064 skip |=
3065 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
3066 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3067 skip |=
3068 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
3069 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3070 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
3071 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003072 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003073 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04003074 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003075 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04003076 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003077 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003078
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003079 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003080
Dave Houlton33c2d252017-06-09 17:08:32 -06003081 VkFormat src_format = src_image_state->createInfo.format;
3082 VkFormat dst_format = dst_image_state->createInfo.format;
3083 VkImageType src_type = src_image_state->createInfo.imageType;
3084 VkImageType dst_type = dst_image_state->createInfo.imageType;
3085
Cort Stratton186b1a22018-05-01 20:18:06 -04003086 if (VK_FILTER_LINEAR == filter) {
3087 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003088 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3089 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003090 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003091 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
3092 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003093 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003094 }
3095
3096 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3097 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 -06003098 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003099 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003100 }
3101
Dave Houlton33c2d252017-06-09 17:08:32 -06003102 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3103 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3104 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 -06003105 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003106 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003107 }
3108
3109 // Validate consistency for unsigned formats
3110 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3111 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003112 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003113 << "the other one must also have unsigned integer format. "
3114 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3115 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 -06003116 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003117 }
3118
3119 // Validate consistency for signed formats
3120 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3121 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003122 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003123 << "the other one must also have signed integer format. "
3124 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3125 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003126 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003127 }
3128
3129 // Validate filter for Depth/Stencil formats
3130 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3131 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003132 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003133 << "then filter must be VK_FILTER_NEAREST.";
3134 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 -06003135 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003136 }
3137
3138 // Validate aspect bits and formats for depth/stencil images
3139 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3140 if (src_format != dst_format) {
3141 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003142 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003143 << "stencil, the other one must have exactly the same format. "
3144 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3145 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003146 skip |=
3147 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3148 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003149 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003150 } // Depth or Stencil
3151
3152 // Do per-region checks
Jeff Bolzfdd0d852019-02-03 21:55:12 -06003153 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable &&
3154 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3155 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3156 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3157 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable &&
3158 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3159 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3160 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003161 for (uint32_t i = 0; i < regionCount; i++) {
3162 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003163 bool hit_error = false;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003164 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003165 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3166 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003167 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003168 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3169 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003170 skip |=
3171 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3172 skip |=
3173 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003174 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3175 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3176 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3177 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3178 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3179 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3180 "VUID-vkCmdBlitImage-srcSubresource-01707");
3181 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3182 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3183 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003184 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003185 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3186 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003187 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003188 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003189 skip |=
3190 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3191 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003192 }
Dave Houlton48989f32017-05-26 15:01:46 -06003193 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3194 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003195 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003196 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003197 skip |=
3198 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3199 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003200 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003201
3202 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003203 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003204 skip |= log_msg(
3205 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3206 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3207 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003208 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003209
Dave Houlton48989f32017-05-26 15:01:46 -06003210 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003211 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003212 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003213 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003214 }
Dave Houlton48989f32017-05-26 15:01:46 -06003215
Dave Houlton33c2d252017-06-09 17:08:32 -06003216 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3217 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 -06003218 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003219 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003220 "image format %s.",
3221 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003222 }
3223
3224 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3225 skip |= log_msg(
3226 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003227 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003228 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3229 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003230 }
3231
Dave Houlton48989f32017-05-26 15:01:46 -06003232 // Validate source image offsets
3233 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003234 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003235 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003236 skip |=
3237 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3238 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3239 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3240 "of (%1d, %1d). These must be (0, 1).",
3241 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003242 }
3243 }
3244
Dave Houlton33c2d252017-06-09 17:08:32 -06003245 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003246 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3247 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 -06003248 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003249 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003250 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3251 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003252 }
3253 }
3254
Dave Houlton33c2d252017-06-09 17:08:32 -06003255 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003256 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3257 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003258 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003259 skip |= log_msg(
3260 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3261 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3262 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3263 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003264 }
3265 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3266 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003267 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003268 skip |= log_msg(
3269 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003270 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003271 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003272 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003273 }
3274 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3275 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003276 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003277 skip |= log_msg(
3278 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3279 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3280 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3281 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003282 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003283 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003284 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 -06003285 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003286 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003287 }
Dave Houlton48989f32017-05-26 15:01:46 -06003288
3289 // Validate dest image offsets
3290 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003291 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003292 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003293 skip |=
3294 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3295 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3296 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3297 "(%1d, %1d). These must be (0, 1).",
3298 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003299 }
3300 }
3301
Dave Houlton33c2d252017-06-09 17:08:32 -06003302 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003303 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3304 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 -06003305 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003306 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003307 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3308 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003309 }
3310 }
3311
Dave Houlton33c2d252017-06-09 17:08:32 -06003312 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003313 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3314 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003315 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003316 skip |= log_msg(
3317 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3318 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3319 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3320 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003321 }
3322 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3323 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003324 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003325 skip |= log_msg(
3326 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003327 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003328 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003329 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003330 }
3331 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3332 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003333 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003334 skip |= log_msg(
3335 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3336 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3337 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3338 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003339 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003340 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003341 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 -06003342 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003343 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003344 }
3345
Dave Houlton33c2d252017-06-09 17:08:32 -06003346 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3347 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3348 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003349 skip |=
3350 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3351 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3352 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3353 "layerCount other than 1.",
3354 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003355 }
3356 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003357 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003358 } else {
3359 assert(0);
3360 }
3361 return skip;
3362}
3363
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003364void PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
3365 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3366 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
3367 auto cb_node = GetCBNode(device_data, commandBuffer);
3368 auto src_image_state = GetImageState(device_data, srcImage);
3369 auto dst_image_state = GetImageState(device_data, dstImage);
3370
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003371 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003372 for (uint32_t i = 0; i < regionCount; ++i) {
3373 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3374 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003375 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003376 // Update bindings between images and cmd buffer
3377 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3378 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003379}
3380
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003381// 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 -07003382bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003383 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3384 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003385 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07003386 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003387 for (auto cb_image_data : pCB->imageLayoutMap) {
3388 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003389
Dave Houltonb3f4b282018-02-22 16:25:16 -07003390 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3391 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003392 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3393 // TODO: Set memory invalid which is in mem_tracker currently
3394 } else if (imageLayout != cb_image_data.second.initialLayout) {
3395 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003396 skip |= log_msg(
3397 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003398 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003399 "Submitted command buffer expects image 0x%" PRIx64
3400 " (subresource: aspectMask 0x%X array layer %u, mip level %u) to be in layout %s--instead, image 0x%" PRIx64
3401 "'s current layout is %s.",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003402 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
3403 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003404 string_VkImageLayout(cb_image_data.second.initialLayout), HandleToUint64(cb_image_data.first.image),
3405 string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003406 } else {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003407 skip |=
3408 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3409 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3410 "Submitted command buffer expects image 0x%" PRIx64 " to be in layout %s--instead, image 0x%" PRIx64
3411 "'s current layout is %s.",
3412 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(cb_image_data.second.initialLayout),
3413 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003414 }
3415 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003416 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003417 }
3418 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003419 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003420}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003421
Tony Barbourdf013b92017-01-25 12:53:48 -07003422void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
3423 for (auto cb_image_data : pCB->imageLayoutMap) {
3424 VkImageLayout imageLayout;
3425 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3426 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3427 }
3428}
3429
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003430// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003431// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3432// layout attachments don't have CLEAR as their loadOp.
Tobias Hectorbbb12282018-10-22 15:17:59 +01003433bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3434 const VkImageLayout first_layout, const uint32_t attachment,
3435 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003436 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003437 const char *vuid;
3438 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3439
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003440 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3441 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003442 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3443 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3444 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003445 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003446 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3447 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3448 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3449 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3450 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3451 skip |=
3452 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3453 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003454 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003455 }
3456 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003457 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3458 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003459 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003460 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003461 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 -06003462 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003463 }
3464 }
3465
3466 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3467 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003468 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003469 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003470 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003471 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003472 }
3473 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003474 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003475}
3476
Tobias Hectorbbb12282018-10-22 15:17:59 +01003477bool ValidateLayouts(const core_validation::layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3478 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003479 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003480 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003481 const char *vuid;
3482 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3483 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003484
Jason Ekstranda1906302017-12-03 20:16:32 -08003485 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3486 VkFormat format = pCreateInfo->pAttachments[i].format;
3487 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3488 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3489 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003490 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 -06003491 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003492 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3493 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3494 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3495 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003496 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003497 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003498 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 -06003499 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003500 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3501 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3502 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3503 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003504 }
3505 }
3506 }
3507
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003508 // Track when we're observing the first use of an attachment
3509 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3510 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003511 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003512
3513 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3514 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3515 auto attach_index = subpass.pInputAttachments[j].attachment;
3516 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003517 switch (subpass.pInputAttachments[j].layout) {
3518 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3519 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3520 // These are ideal.
3521 break;
3522
3523 case VK_IMAGE_LAYOUT_GENERAL:
3524 // May not be optimal. TODO: reconsider this warning based on other constraints.
3525 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003526 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003527 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3528 break;
3529
Tobias Hectorbbb12282018-10-22 15:17:59 +01003530 case VK_IMAGE_LAYOUT_UNDEFINED:
3531 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3532 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3533 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3534 "Layout for input attachment reference %u in subpass %u is %s but must be "
3535 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3536 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3537 break;
3538
Graeme Leese668a9862018-10-08 10:40:02 +01003539 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3540 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3541 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3542 break;
3543 } else {
3544 // Intentionally fall through to generic error message
3545 }
3546 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003547
Cort Stratton7547f772017-05-04 15:18:52 -07003548 default:
3549 // No other layouts are acceptable
3550 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 -06003551 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003552 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3553 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3554 }
3555
Cort Stratton7547f772017-05-04 15:18:52 -07003556 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003557 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3558 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003559
3560 bool used_as_depth =
3561 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3562 bool used_as_color = false;
3563 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3564 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3565 }
3566 if (!used_as_depth && !used_as_color &&
3567 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003568 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3569 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3570 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3571 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003572 }
3573 }
3574 attach_first_use[attach_index] = false;
3575 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003576
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003577 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3578 auto attach_index = subpass.pColorAttachments[j].attachment;
3579 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3580
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003581 // TODO: Need a way to validate shared presentable images here, currently just allowing
3582 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3583 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003584 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003585 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003586 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003587 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3588 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003589 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003590
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003591 case VK_IMAGE_LAYOUT_GENERAL:
3592 // May not be optimal; TODO: reconsider this warning based on other constraints?
3593 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003594 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003595 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3596 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003597
Tobias Hectorbbb12282018-10-22 15:17:59 +01003598 case VK_IMAGE_LAYOUT_UNDEFINED:
3599 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3600 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3601 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3602 "Layout for color attachment reference %u in subpass %u is %s but should be "
3603 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3604 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3605 break;
3606
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003607 default:
3608 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 -06003609 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003610 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3611 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003612 }
3613
John Zulauf4eee2692019-02-09 16:14:25 -07003614 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3615 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3616 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003617 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3618 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
John Zulauf4eee2692019-02-09 16:14:25 -07003619 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003620 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3621 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3622 }
3623
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003624 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003625 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3626 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003627 }
3628 attach_first_use[attach_index] = false;
3629 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003630
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003631 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3632 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003633 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3634 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3635 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003636 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003637
Dave Houltona9df0ce2018-02-07 10:51:23 -07003638 case VK_IMAGE_LAYOUT_GENERAL:
3639 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3640 // doing a bunch of transitions.
3641 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003642 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003643 "GENERAL layout for depth attachment may not give optimal performance.");
3644 break;
3645
Tobias Hectorbbb12282018-10-22 15:17:59 +01003646 case VK_IMAGE_LAYOUT_UNDEFINED:
3647 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3648 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3649 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3650 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3651 "layout or GENERAL.",
3652 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3653 break;
3654
Dave Houltona9df0ce2018-02-07 10:51:23 -07003655 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3656 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3657 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3658 break;
3659 } else {
3660 // Intentionally fall through to generic error message
3661 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003662 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003663
Dave Houltona9df0ce2018-02-07 10:51:23 -07003664 default:
3665 // No other layouts are acceptable
3666 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 -06003667 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003668 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3669 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3670 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003671 }
3672
3673 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3674 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003675 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3676 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003677 }
3678 attach_first_use[attach_index] = false;
3679 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003680 }
3681 return skip;
3682}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003683
3684// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003685bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3686 VkDeviceSize offset, VkDeviceSize end_offset) {
3687 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3688 bool skip = false;
3689 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3690 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003691 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3692 for (auto image_handle : mem_info->bound_images) {
3693 auto img_it = mem_info->bound_ranges.find(image_handle);
3694 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003695 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003696 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003697 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003698 for (auto layout : layouts) {
3699 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003700 skip |=
3701 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 -06003702 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003703 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3704 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003705 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003706 }
3707 }
3708 }
3709 }
3710 }
3711 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003712 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003713}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003714
3715// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3716// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003717static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
Jeff Bolzfdd0d852019-02-03 21:55:12 -06003718 VulkanObjectType obj_type, const char *msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003719 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003720
3721 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003722 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003723 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003724 if (strict) {
3725 correct_usage = ((actual & desired) == desired);
3726 } else {
3727 correct_usage = ((actual & desired) != 0);
3728 }
3729 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003730 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003731 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003732 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003733 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 -06003734 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003735 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3736 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003737 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003738 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003739 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 -06003740 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3741 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003742 }
3743 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003744 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003745}
3746
3747// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3748// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003749bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Jeff Bolzfdd0d852019-02-03 21:55:12 -06003750 const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003751 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3752 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003753}
3754
Cort Stratton186b1a22018-05-01 20:18:06 -04003755bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06003756 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003757 VkFormatProperties format_properties = GetPDFormatProperties(dev_data, image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003758 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3759 bool skip = false;
3760 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3761 if ((format_properties.linearTilingFeatures & desired) != desired) {
3762 skip |=
3763 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3764 HandleToUint64(image_state->image), linear_vuid,
3765 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3766 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3767 }
3768 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3769 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3770 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3771 HandleToUint64(image_state->image), optimal_vuid,
3772 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3773 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3774 HandleToUint64(image_state->image));
3775 }
3776 }
3777 return skip;
3778}
3779
Cort Strattond619a302018-05-17 19:46:32 -07003780bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3781 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3782 uint32_t i) {
3783 bool skip = false;
3784 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3785 // layerCount must not be zero
3786 if (subresource_layers->layerCount == 0) {
3787 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3788 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3789 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3790 }
3791 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3792 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3793 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3794 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3795 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3796 }
3797 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3798 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3799 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3801 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3802 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3803 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3804 func_name, i, member);
3805 }
3806 return skip;
3807}
3808
Mark Lobodzinski96210742017-02-09 10:33:46 -07003809// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3810// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003811bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Jeff Bolzfdd0d852019-02-03 21:55:12 -06003812 const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003813 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3814 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003815}
3816
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003817bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3818 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3819 bool skip = false;
3820 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3821
3822 const VkDeviceSize &range = pCreateInfo->range;
3823 if (range != VK_WHOLE_SIZE) {
3824 // Range must be greater than 0
3825 if (range <= 0) {
3826 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3827 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3828 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3829 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3830 range);
3831 }
3832 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003833 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003834 if (range % format_size != 0) {
3835 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3836 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3837 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3838 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3839 "(" PRINTF_SIZE_T_SPECIFIER ").",
3840 range, format_size);
3841 }
3842 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3843 if (range / format_size > device_limits->maxTexelBufferElements) {
3844 skip |=
3845 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3846 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3847 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3848 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3849 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3850 range, format_size, device_limits->maxTexelBufferElements);
3851 }
3852 // The sum of range and offset must be less than or equal to the size of buffer
3853 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3854 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3855 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3856 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3857 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3858 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3859 range, pCreateInfo->offset, buffer_state->createInfo.size);
3860 }
3861 }
3862 return skip;
3863}
3864
Shannon McPherson265383a2018-06-21 15:37:52 -06003865bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3866 const VkBufferViewCreateInfo *pCreateInfo) {
3867 bool skip = false;
3868 const debug_report_data *report_data = GetReportData(device_data);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003869 const VkFormatProperties format_properties = GetPDFormatProperties(device_data, pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003870 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3871 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3872 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3873 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3874 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3875 "be supported for uniform texel buffers");
3876 }
3877 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3878 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3879 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3880 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3881 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3882 "be supported for storage texel buffers");
3883 }
3884 return skip;
3885}
3886
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003887bool PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
3888 VkBuffer *pBuffer) {
3889 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3890
Mark Lobodzinski96210742017-02-09 10:33:46 -07003891 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003892 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003893
Dave Houltond8ed0212018-05-16 17:18:24 -06003894 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003895
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003896 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003897 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 -06003898 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003899 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003900 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003901 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003902
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003903 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3904 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003905 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 -06003906 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003907 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003908 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003909 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003910
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003911 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3912 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003913 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 -06003914 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003915 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003916 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003917 }
Jeff Bolz87697532019-01-11 22:54:00 -06003918
3919 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3920 if (chained_devaddr_struct) {
3921 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3922 chained_devaddr_struct->deviceAddress != 0) {
3923 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3924 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3925 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3926 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3927 }
3928 }
3929
3930 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3931 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddressCaptureReplay) {
3932 skip |= log_msg(
3933 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3934 "VUID-VkBufferCreateInfo-flags-02605",
3935 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3936 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3937 }
3938
3939 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
3940 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddress) {
3941 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3942 "VUID-VkBufferCreateInfo-usage-02606",
3943 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3944 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3945 }
3946
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003947 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
3948 skip |= core_validation::ValidateQueueFamilies(
3949 device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3950 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3951 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
3952 }
3953
Mark Lobodzinski96210742017-02-09 10:33:46 -07003954 return skip;
3955}
3956
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003957void PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003958 VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003959 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003960 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003961 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3962 GetBufferMap(device_data)
3963 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3964}
3965
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003966bool PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3967 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
3968 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3969
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003970 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003971 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003972 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003973 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3974 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003975 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3976 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003977 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3978 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003979 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3980 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3981 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3982 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003983
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003984 // Buffer view offset must be less than the size of buffer
3985 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3986 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3987 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3988 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3989 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3990 pCreateInfo->offset, buffer_state->createInfo.size);
3991 }
3992
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07003993 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06003994 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3995 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3996 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3997 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3998 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3999 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4000 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4001 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004002
4003 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004004
4005 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004006 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004007 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004008}
4009
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004010void PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004011 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004012 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004013 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004014 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
4015}
Mark Lobodzinski602de982017-02-09 11:01:33 -07004016
4017// For the given format verify that the aspect masks make sense
Tobias Hectorbbb12282018-10-22 15:17:59 +01004018bool ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
4019 const char *func_name, const char *vuid) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004020 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004021 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004022 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4023 if (image != VK_NULL_HANDLE) {
4024 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4025 }
4026
Dave Houlton1d2022c2017-03-29 11:43:58 -06004027 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004028 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004029 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004030 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004031 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004032 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004033 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004034 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004035 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004036 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004037 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004038 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004039 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4040 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004041 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004042 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004043 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004044 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4045 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004046 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004047 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004048 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004049 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004050 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004051 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004052 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004053 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004054 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004055 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004056 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004057 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004058 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004059 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004060 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004061 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004062 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004063 } else if (FormatIsMultiplane(format)) {
4064 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4065 if (3 == FormatPlaneCount(format)) {
4066 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4067 }
4068 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004069 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004070 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4071 "set, where n = [0, 1, 2].",
4072 func_name);
4073 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004074 }
4075 return skip;
4076}
4077
Petr Krausffa94af2017-08-08 21:46:02 +02004078struct SubresourceRangeErrorCodes {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004079 const char *base_mip_err, *mip_count_err, *base_layer_err, *layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02004080};
4081
4082bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
4083 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
4084 const char *image_layer_count_var_name, const uint64_t image_handle,
4085 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004086 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4087 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004088
4089 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004090 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004091 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 -06004092 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004093 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004094 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4095 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004096 }
Petr Kraus4d718682017-05-18 03:38:41 +02004097
Petr Krausffa94af2017-08-08 21:46:02 +02004098 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4099 if (subresourceRange.levelCount == 0) {
4100 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 -06004101 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004102 } else {
4103 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004104
Petr Krausffa94af2017-08-08 21:46:02 +02004105 if (necessary_mip_count > image_mip_count) {
4106 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 -06004107 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004108 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004109 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004110 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004111 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004112 }
Petr Kraus4d718682017-05-18 03:38:41 +02004113 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004114 }
Petr Kraus4d718682017-05-18 03:38:41 +02004115
4116 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004117 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004118 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 -06004119 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004120 "%s: %s.baseArrayLayer (= %" PRIu32
4121 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4122 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004123 }
Petr Kraus4d718682017-05-18 03:38:41 +02004124
Petr Krausffa94af2017-08-08 21:46:02 +02004125 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4126 if (subresourceRange.layerCount == 0) {
4127 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 -06004128 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004129 } else {
4130 const uint64_t necessary_layer_count =
4131 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004132
Petr Krausffa94af2017-08-08 21:46:02 +02004133 if (necessary_layer_count > image_layer_count) {
4134 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004135 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004136 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004137 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004138 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004139 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004140 }
Petr Kraus4d718682017-05-18 03:38:41 +02004141 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004142 }
Petr Kraus4d718682017-05-18 03:38:41 +02004143
Mark Lobodzinski602de982017-02-09 11:01:33 -07004144 return skip;
4145}
4146
Petr Krausffa94af2017-08-08 21:46:02 +02004147bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4148 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
4149 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
4150 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4151 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4152 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4153
4154 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4155 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4156
4157 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004158 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4159 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4160 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4161 : "VUID-VkImageViewCreateInfo-image-01482")
4162 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4163 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4164 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4165 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4166 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004167
4168 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4169 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4170 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4171}
4172
4173bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4174 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4175 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004176 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4177 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4178 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4179 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004180
4181 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4182 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4183 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4184}
4185
4186bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4187 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4188 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004189 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4190 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4191 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4192 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004193
4194 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4195 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4196 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4197}
4198
4199bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4200 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4201 const char *param_name) {
4202 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004203 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4204 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4205 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4206 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004207
4208 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4209 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4210 subresourceRangeErrorCodes);
4211}
4212
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004213bool PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4214 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
4215 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4216 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004217 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004218 IMAGE_STATE *image_state = GetImageState(device_data, pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004219 if (image_state) {
4220 skip |= ValidateImageUsageFlags(
4221 device_data, image_state,
4222 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004223 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4224 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004225 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004226 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004227 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004228 skip |=
4229 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004230 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004231 skip |= ValidateCreateImageViewSubresourceRange(
4232 device_data, image_state,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004233 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4234 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004235
4236 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4237 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004238 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4239 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004240 VkFormat view_format = pCreateInfo->format;
4241 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004242 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004243 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004244
Dave Houltonbd2e2622018-04-10 16:41:14 -06004245 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004246 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004247 if (chained_ivuci_struct) {
4248 if (chained_ivuci_struct->usage & ~image_usage) {
4249 std::stringstream ss;
4250 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004251 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004252 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004253 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 -07004254 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004255 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004256 }
4257
4258 image_usage = chained_ivuci_struct->usage;
4259 }
4260
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004261 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4262 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004263 if (FormatIsMultiplane(image_format)) {
4264 // View format must match the multiplane compatible format
4265 uint32_t plane = 3; // invalid
4266 switch (aspect_mask) {
4267 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4268 plane = 0;
4269 break;
4270 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4271 plane = 1;
4272 break;
4273 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4274 plane = 2;
4275 break;
4276 default:
4277 break;
4278 }
4279
4280 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4281 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004282 std::stringstream ss;
4283 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004284 << " is not compatible with plane " << plane << " of underlying image format "
4285 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004286 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004287 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004288 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004289 }
4290 } else {
4291 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
4292 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4293 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4294 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4295 std::stringstream ss;
4296 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004297 << " is not in the same format compatibility class as image (" << HandleToUint64(pCreateInfo->image)
Dave Houltonc7988072018-04-16 11:46:56 -06004298 << ") format " << string_VkFormat(image_format)
4299 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4300 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004301 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 -07004302 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004303 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004304 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004305 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004306 }
4307 } else {
4308 // Format MUST be IDENTICAL to the format the image was created with
4309 if (image_format != view_format) {
4310 std::stringstream ss;
4311 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004312 << HandleToUint64(pCreateInfo->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004313 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004314 skip |=
4315 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004316 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004317 }
4318 }
4319
4320 // Validate correct image aspect bits for desired formats and format consistency
4321 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004322
4323 switch (image_type) {
4324 case VK_IMAGE_TYPE_1D:
4325 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004326 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 -07004327 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004328 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4329 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004330 }
4331 break;
4332 case VK_IMAGE_TYPE_2D:
4333 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4334 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4335 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004336 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 -07004337 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004338 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4339 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004340 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004341 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 -07004342 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004343 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4344 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004345 }
4346 }
4347 break;
4348 case VK_IMAGE_TYPE_3D:
4349 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4350 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4351 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4352 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004353 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004354 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004355 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004356 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4357 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004358 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4359 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004360 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004361 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004362 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004363 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4364 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004365 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4366 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004367 }
4368 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004369 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004370 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004371 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4372 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004373 }
4374 }
4375 } else {
4376 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004377 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 -07004378 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004379 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4380 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004381 }
4382 }
4383 break;
4384 default:
4385 break;
4386 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004387
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004388 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
4389 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004390 skip |= ValidateCreateImageViewANDROID(device_data, pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004391 }
4392
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004393 VkFormatProperties format_properties = GetPDFormatProperties(device_data, view_format);
4394 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4395 : format_properties.optimalTilingFeatures;
4396
4397 if (tiling_features == 0) {
4398 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 -07004399 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004400 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4401 "physical device.",
4402 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4403 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4404 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 -07004405 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004406 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4407 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4408 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4409 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4410 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 -07004411 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004412 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4413 "VK_IMAGE_USAGE_STORAGE_BIT.",
4414 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4415 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4416 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4417 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004418 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004419 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4420 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4421 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4422 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4423 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004425 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004426 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4427 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4428 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004429 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004430
Jeff Bolz9af91c52018-09-01 21:53:57 -05004431 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4432 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4433 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 -07004434 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004435 "vkCreateImageView() If image was created with usage containing "
4436 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4437 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4438 }
4439 if (view_format != VK_FORMAT_R8_UINT) {
4440 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004441 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004442 "vkCreateImageView() If image was created with usage containing "
4443 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4444 }
4445 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004446 }
4447 return skip;
4448}
4449
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004450void PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004451 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004452 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004453 if (result != VK_SUCCESS) return;
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004454 auto image_view_map = GetImageViewMap(device_data);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004455 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004456
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004457 auto image_state = GetImageState(device_data, pCreateInfo->image);
4458 auto &sub_res_range = (*image_view_map)[*pView].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004459 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4460 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004461}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004462
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004463bool PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
4464 const VkBufferCopy *pRegions) {
4465 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4466 auto cb_node = GetCBNode(device_data, commandBuffer);
4467 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
4468 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4469
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004470 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004471 skip |=
4472 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4473 skip |=
4474 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004475 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004476 skip |=
4477 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4478 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4479 skip |=
4480 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4481 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004482 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004483 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4484 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004485 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004486 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004487 return skip;
4488}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004489
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004490void PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
4491 const VkBufferCopy *pRegions) {
4492 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4493 auto cb_node = GetCBNode(device_data, commandBuffer);
4494 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
4495 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4496
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004497 // Update bindings between buffers and cmd buffer
4498 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4499 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004500}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004501
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004502static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004503 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4504 bool skip = false;
4505 auto buffer_state = GetBufferState(device_data, buffer);
4506 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004507 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 -06004508 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01004509 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004510 } else {
4511 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004512 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 -06004513 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004514 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004515 }
4516 }
4517 return skip;
4518}
4519
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004520bool PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
4521 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4522 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(device_data, imageView);
4523 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4524
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004525 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004526 if (image_view_state) {
4527 skip |= ValidateObjectNotInUse(device_data, image_view_state, obj_struct, "vkDestroyImageView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004528 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004529 }
4530 return skip;
4531}
4532
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004533void PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
4534 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4535 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(device_data, imageView);
4536 if (!image_view_state) return;
4537 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4538
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004539 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004540 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004541 (*GetImageViewMap(device_data)).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004542}
4543
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004544bool PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4545 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4546 auto buffer_state = GetBufferState(device_data, buffer);
4547
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004548 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004549 if (buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004550 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004551 }
4552 return skip;
4553}
4554
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004555void PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4556 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4557 if (!buffer) return;
4558 auto buffer_state = GetBufferState(device_data, buffer);
4559 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4560
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004561 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004562 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4563 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4564 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004565 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004566 }
4567 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004568 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004569 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004570 GetBufferMap(device_data)->erase(buffer_state->buffer);
4571}
4572
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004573bool PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
4574 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4575 auto buffer_view_state = GetBufferViewState(device_data, bufferView);
4576 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004577 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004578 if (buffer_view_state) {
4579 skip |= ValidateObjectNotInUse(device_data, buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004580 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004581 }
4582 return skip;
4583}
4584
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004585void PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
4586 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4587 if (!bufferView) return;
4588 auto buffer_view_state = GetBufferViewState(device_data, bufferView);
4589 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4590
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004591 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004592 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004593 GetBufferViewMap(device_data)->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004594}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004595
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004596bool PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset, VkDeviceSize size,
4597 uint32_t data) {
4598 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4599 auto cb_node = GetCBNode(device_data, commandBuffer);
4600 auto buffer_state = GetBufferState(device_data, dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004601 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004602 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004603 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004604 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4605 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004606 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4607 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004608 skip |=
4609 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4610 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004611 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004612 return skip;
4613}
4614
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004615void PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset, VkDeviceSize size,
4616 uint32_t data) {
4617 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4618 auto cb_node = GetCBNode(device_data, commandBuffer);
4619 auto buffer_state = GetBufferState(device_data, dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004620 // Update bindings between buffer and cmd buffer
4621 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004622}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004623
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004624bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4625 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004626 bool skip = false;
4627
4628 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004629 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4630 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004631 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 -06004632 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004633 "%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 -06004634 "and 1, respectively.",
4635 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004636 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004637 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004638
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004639 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4640 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004641 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 -06004642 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004643 "%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 -06004644 "must be 0 and 1, respectively.",
4645 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004646 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004647 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004648
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004649 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4650 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004651 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 -06004652 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004653 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4654 "For 3D images these must be 0 and 1, respectively.",
4655 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004656 }
4657 }
4658
4659 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004660 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
4661 uint32_t element_size = FormatElementSize(image_state->createInfo.format);
4662 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004663 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 -06004664 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004665 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004666 " must be a multiple of this format's texel size (%" PRIu32 ").",
4667 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004668 }
4669
4670 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004671 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004672 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 -06004673 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004674 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4675 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004676 }
4677
4678 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4679 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004680 skip |=
4681 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-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004683 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4684 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004685 }
4686
4687 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4688 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4689 skip |= log_msg(
4690 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-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004692 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4693 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004694 }
4695
4696 // subresource aspectMask must have exactly 1 bit set
4697 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4698 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4699 if (aspect_mask_bits.count() != 1) {
4700 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 -06004701 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004702 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004703 }
4704
4705 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004706 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004707 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-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004710 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4711 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004712 }
4713
4714 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004715 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004716 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004717
4718 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004719 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004720 skip |= log_msg(
4721 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004722 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004723 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4724 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004725 }
4726
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004727 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004728 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004729 skip |= log_msg(
4730 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004731 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004732 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4733 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004734 }
4735
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004736 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004737 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4738 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4739 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004740 skip |=
4741 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004742 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004743 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4744 "width & height (%d, %d)..",
4745 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004746 }
4747
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004748 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004749 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004750 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004751 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 -06004752 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004753 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004754 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004755 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004756 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004757
4758 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004759 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004760 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004761 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4762 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 -06004763 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004764 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004765 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004766 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004767 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004768 }
4769
4770 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004771 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004772 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4773 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 -06004774 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004775 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004776 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004777 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004778 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004779 }
4780
4781 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004782 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004783 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4784 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 -06004785 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004786 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004787 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004788 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004789 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004790 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004791 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004792 }
4793
4794 return skip;
4795}
4796
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004797static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004798 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004799 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004800 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004801
4802 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004803 VkExtent3D extent = pRegions[i].imageExtent;
4804 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004805
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004806 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4807 {
Dave Houlton51653902018-06-22 17:32:13 -06004808 skip |=
4809 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4810 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4811 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004812 }
4813
4814 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4815
4816 // 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 -06004817 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004818 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004819 if (image_extent.width % block_extent.width) {
4820 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4821 }
4822 if (image_extent.height % block_extent.height) {
4823 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4824 }
4825 if (image_extent.depth % block_extent.depth) {
4826 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4827 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004828 }
4829
Dave Houltonfc1a4052017-04-27 14:32:45 -06004830 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004831 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 -06004832 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004833 }
4834 }
4835
4836 return skip;
4837}
4838
Chris Forbese8ba09a2017-06-01 17:39:02 -07004839static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004840 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004841 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004842 bool skip = false;
4843
4844 VkDeviceSize buffer_size = buff_state->createInfo.size;
4845
4846 for (uint32_t i = 0; i < regionCount; i++) {
4847 VkExtent3D copy_extent = pRegions[i].imageExtent;
4848
4849 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4850 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houltona585d132019-01-18 13:05:42 -07004851 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004852
Dave Houltonf3229d52017-02-21 15:59:08 -07004853 // Handle special buffer packing rules for specific depth/stencil formats
4854 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houltona585d132019-01-18 13:05:42 -07004855 unit_size = FormatElementSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004856 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4857 switch (image_state->createInfo.format) {
4858 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004859 unit_size = FormatElementSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004860 break;
4861 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004862 unit_size = FormatElementSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004863 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004864 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004865 case VK_FORMAT_D24_UNORM_S8_UINT:
4866 unit_size = 4;
4867 break;
4868 default:
4869 break;
4870 }
4871 }
4872
Tom Cooperb2550c72018-10-15 13:08:41 +01004873 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004874 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004875 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004876 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4877 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4878
4879 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4880 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4881 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004882 }
4883
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004884 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4885 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4886 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004887 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004888 } else {
4889 // Calculate buffer offset of final copied byte, + 1.
4890 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4891 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4892 max_buffer_offset *= unit_size; // convert to bytes
4893 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004894
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004895 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004896 skip |=
4897 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4898 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004899 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004900 }
4901 }
4902
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004903 return skip;
4904}
4905
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004906bool PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4907 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4908 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4909 auto cb_node = GetCBNode(device_data, commandBuffer);
4910 auto src_image_state = GetImageState(device_data, srcImage);
4911 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4912 const debug_report_data *report_data = device_data->report_data;
4913
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004914 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4915
4916 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004917 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004918
4919 // Command pool must support graphics, compute, or transfer operations
4920 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4921
4922 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4923 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4924 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 -06004925 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004926 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004927 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004928 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004929 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004930 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004931 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004932 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004933
4934 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004935 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4936 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4937 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4938 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4939 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004940
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004941 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004942 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4943 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4944 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004945 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004946 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4947 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004948 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4949 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004950 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4951 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004952 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004953 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004954 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004955 const char *src_invalid_layout_vuid =
Cort Stratton7df30962018-05-17 19:45:57 -07004956 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4957 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4958 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004959 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004960 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4961 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004962 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004963 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4964 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004965 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004966 "vkCmdCopyImageToBuffer()",
4967 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004968 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4969 "vkCmdCopyImageToBuffer()", "imageSubresource",
4970 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4971 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4972 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4973 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004974 }
4975 return skip;
4976}
4977
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004978void PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4979 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4980 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4981 auto cb_node = GetCBNode(device_data, commandBuffer);
4982 auto src_image_state = GetImageState(device_data, srcImage);
4983 auto dst_buffer_state = GetBufferState(device_data, dstBuffer);
4984
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004985 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004986 for (uint32_t i = 0; i < regionCount; ++i) {
4987 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004988 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004989 // Update bindings between buffer/image and cmd buffer
4990 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004991 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004992}
4993
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004994bool PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4995 VkImageLayout dstImageLayout, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4996 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
4997 auto cb_node = GetCBNode(device_data, commandBuffer);
4998 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
4999 auto dst_image_state = GetImageState(device_data, dstImage);
5000 const debug_report_data *report_data = device_data->report_data;
5001
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005002 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
5003
5004 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07005005 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005006
5007 // Command pool must support graphics, compute, or transfer operations
5008 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
5009 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
5010 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5011 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 -06005012 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005013 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005014 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005015 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005016 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005017 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005018 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005019 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005020 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005021 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
5022 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
5023 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5024 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
5025 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06005026 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005027 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5028 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5029 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
5030 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5031 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04005032 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
5033 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005034 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
5035 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005036 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06005037 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005038 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06005039 const char *dst_invalid_layout_vuid =
Cort Stratton7df30962018-05-17 19:45:57 -07005040 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
5041 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5042 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005043 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07005044 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
5045 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06005046 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005047 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5048 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005049 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06005050 "vkCmdCopyBufferToImage()",
5051 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07005052 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
5053 "vkCmdCopyBufferToImage()", "imageSubresource",
5054 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5055 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
5056 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5057 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005058 }
5059 return skip;
5060}
5061
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005062void PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5063 VkImageLayout dstImageLayout, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5064 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
5065 auto cb_node = GetCBNode(device_data, commandBuffer);
5066 auto src_buffer_state = GetBufferState(device_data, srcBuffer);
5067 auto dst_image_state = GetImageState(device_data, dstImage);
5068
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005069 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005070 for (uint32_t i = 0; i < regionCount; ++i) {
5071 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005072 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07005073 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005074 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005075}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005076
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07005077bool PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5078 VkSubresourceLayout *pLayout) {
5079 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
5080 const auto report_data = device_data->report_data;
Mike Weiblen672b58b2017-02-21 14:32:53 -07005081 bool skip = false;
5082 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5083
Dave Houlton1d960ff2018-01-19 12:17:05 -07005084 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005085 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5086 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5087 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005088 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 -06005089 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005090 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005091 }
5092
5093 IMAGE_STATE *image_entry = GetImageState(device_data, image);
5094 if (!image_entry) {
5095 return skip;
5096 }
5097
Dave Houlton1d960ff2018-01-19 12:17:05 -07005098 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005099 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005100 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5101 "VUID-vkGetImageSubresourceLayout-image-00996",
5102 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005103 }
5104
Dave Houlton1d960ff2018-01-19 12:17:05 -07005105 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005106 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005107 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5108 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5109 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5110 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005111 }
5112
Dave Houlton1d960ff2018-01-19 12:17:05 -07005113 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005114 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005115 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5116 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5117 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5118 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005119 }
5120
Dave Houlton1d960ff2018-01-19 12:17:05 -07005121 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005122 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005123 if (FormatIsMultiplane(img_format)) {
5124 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005125 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005126 if (FormatPlaneCount(img_format) > 2u) {
5127 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005128 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005129 }
5130 if (sub_aspect != (sub_aspect & allowed_flags)) {
5131 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 -06005132 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005133 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005134 ") must be a single-plane specifier flag.",
5135 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005136 }
5137 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005138 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005139 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005140 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005141 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005142 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005143 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005144 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005145 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005146 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 -06005147 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005148 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005149 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005150 }
5151 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005152
5153 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
5154 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
5155 }
5156
Mike Weiblen672b58b2017-02-21 14:32:53 -07005157 return skip;
5158}