blob: ca05431431a26c359da143abdb65f79e125244cc [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",
476 "vkCmdBeginRenderPass() :framebuffer 0x%" PRIx64 " pAttachments[%" PRIu32 "] = 0x%" PRIx64
477 " is not a valid VkImageView handle",
478 HandleToUint64(framebuffer_state->framebuffer), i, HandleToUint64(image_view));
479 continue;
480 }
481
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700482 const VkImage &image = view_state->create_info.image;
483 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700484 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100485 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
486
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700487 // TODO: Do not iterate over every possibility - consolidate where possible
488 for (uint32_t j = 0; j < subRange.levelCount; j++) {
489 uint32_t level = subRange.baseMipLevel + j;
490 for (uint32_t k = 0; k < subRange.layerCount; k++) {
491 uint32_t layer = subRange.baseArrayLayer + k;
492 VkImageSubresource sub = {subRange.aspectMask, level, layer};
493 IMAGE_CMD_BUF_LAYOUT_NODE node;
494 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700495 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700496 continue;
497 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700498 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600499 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -0600500 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700501 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
502 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
503 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600504 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700505 }
506 }
507 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100508
509 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, initial_layout, image, image_view,
510 framebuffer, render_pass, i, "initial layout");
511
512 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, final_layout, image, image_view, framebuffer,
513 render_pass, i, "final layout");
514 }
515
516 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
517 auto &subpass = pRenderPassInfo->pSubpasses[j];
518 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
519 auto &attachment_ref = subpass.pInputAttachments[k];
520 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
521 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
522 auto view_state = GetImageViewState(device_data, image_view);
523
524 if (view_state) {
525 auto image = view_state->create_info.image;
526 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
527 image_view, framebuffer, render_pass,
528 attachment_ref.attachment, "input attachment layout");
529 }
530 }
531 }
532
533 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
534 auto &attachment_ref = subpass.pColorAttachments[k];
535 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
536 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
537 auto view_state = GetImageViewState(device_data, image_view);
538
539 if (view_state) {
540 auto image = view_state->create_info.image;
541 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
542 image_view, framebuffer, render_pass,
543 attachment_ref.attachment, "color attachment layout");
544 if (subpass.pResolveAttachments) {
545 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
546 device_data, rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
547 attachment_ref.attachment, "resolve attachment layout");
548 }
549 }
550 }
551 }
552
553 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
554 auto &attachment_ref = *subpass.pDepthStencilAttachment;
555 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
556 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
557 auto view_state = GetImageViewState(device_data, image_view);
558
559 if (view_state) {
560 auto image = view_state->create_info.image;
561 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
562 image_view, framebuffer, render_pass,
563 attachment_ref.attachment, "input attachment layout");
564 }
565 }
566 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700567 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600568 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700569}
570
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700571void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Tobias Hectorbbb12282018-10-22 15:17:59 +0100572 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700573 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf8e308292018-09-21 11:34:37 -0600574 auto image_view = GetAttachmentImageViewState(device_data, pFramebuffer, ref.attachment);
575 if (image_view) {
576 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
577 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700578 }
579}
580
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700581void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700582 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700583 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700584
585 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700586 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700587 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
588 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
589 }
590 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
591 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
592 }
593 if (subpass.pDepthStencilAttachment) {
594 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
595 }
596 }
597}
598
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600599bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700600 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700601 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
602 return false;
603 }
604 VkImageSubresource sub = {aspect, level, layer};
605 IMAGE_CMD_BUF_LAYOUT_NODE node;
606 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700607 return false;
608 }
609 bool skip = false;
610 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
611 // TODO: Set memory invalid which is in mem_tracker currently
612 } else if (node.layout != mem_barrier->oldLayout) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600613 skip = log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
614 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
615 "VUID-VkImageMemoryBarrier-oldLayout-01197",
616 "For image 0x%" PRIx64
617 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
618 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
619 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700620 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700621 return skip;
622}
623
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700624// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
625// 1. Transition into initialLayout state
626// 2. Transition from initialLayout to layout used in subpass 0
627void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
628 FRAMEBUFFER_STATE *framebuffer_state) {
629 // First transition into initialLayout
630 auto const rpci = render_pass_state->createInfo.ptr();
631 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -0600632 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
633 if (view_state) {
634 SetImageViewLayout(device_data, cb_state, view_state, rpci->pAttachments[i].initialLayout);
635 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700636 }
637 // Now transition for first subpass (index 0)
638 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
639}
640
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700641void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
Tony-LunarG0d27b302018-10-08 09:26:21 -0600642 uint32_t level, uint32_t layer, VkImageAspectFlags aspect_mask, VkImageAspectFlags aspect) {
643 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700644 return;
645 }
646 VkImageSubresource sub = {aspect, level, layer};
647 IMAGE_CMD_BUF_LAYOUT_NODE node;
648 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700649 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700650 SetLayout(device_data, pCB, mem_barrier->image, sub,
651 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
652 return;
653 }
654 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
655 // TODO: Set memory invalid
656 }
657 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
658}
659
Dave Houlton10b39482017-03-16 13:18:15 -0600660bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600661 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600662 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600663 }
664 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600665 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600666 }
667 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600668 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600669 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700670 if (0 !=
671 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
672 if (FormatPlaneCount(format) == 1) return false;
673 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600674 return true;
675}
676
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
678bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
679 VkImageUsageFlags usage_flags, const char *func_name) {
680 const auto report_data = core_validation::GetReportData(device_data);
681 bool skip = false;
682 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Dave Houlton8e9f6542018-05-18 12:18:22 -0600683 std::string msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684
685 switch (layout) {
686 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
687 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600688 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700689 }
690 break;
691 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
692 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600693 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700694 }
695 break;
696 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
697 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600698 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700699 }
700 break;
701 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
702 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600703 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700704 }
705 break;
706 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
707 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600708 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700709 }
710 break;
711 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
712 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600713 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700714 }
715 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600716 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500717 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
718 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
719 }
720 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700721 default:
722 // Other VkImageLayout values do not have VUs defined in this context.
723 break;
724 }
725
Dave Houlton8e9f6542018-05-18 12:18:22 -0600726 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600727 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600728 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600729 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
730 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
731 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700732 }
733 return skip;
734}
735
John Zulauf463c51e2018-05-31 13:29:20 -0600736// Scoreboard for checking for duplicate and inconsistent barriers to images
737struct ImageBarrierScoreboardEntry {
738 uint32_t index;
739 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
740 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
741 const VkImageMemoryBarrier *barrier;
742};
743using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
744using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
745
Mike Weiblen62d08a32017-03-07 22:18:27 -0700746// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600747bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700748 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700749 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700750
John Zulauf463c51e2018-05-31 13:29:20 -0600751 // Scoreboard for duplicate layout transition barriers within the list
752 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
753 ImageBarrierScoreboardImageMap layout_transitions;
754
Mike Weiblen62d08a32017-03-07 22:18:27 -0700755 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
756 auto img_barrier = &pImageMemoryBarriers[i];
757 if (!img_barrier) continue;
758
John Zulauf463c51e2018-05-31 13:29:20 -0600759 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
760 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
761 // at a per sub-resource level
762 if (img_barrier->oldLayout != img_barrier->newLayout) {
763 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
764 auto image_it = layout_transitions.find(img_barrier->image);
765 if (image_it != layout_transitions.end()) {
766 auto &subres_map = image_it->second;
767 auto subres_it = subres_map.find(img_barrier->subresourceRange);
768 if (subres_it != subres_map.end()) {
769 auto &entry = subres_it->second;
770 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
771 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
772 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
773 skip = log_msg(
774 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
775 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_state->commandBuffer),
776 "VUID-VkImageMemoryBarrier-oldLayout-01197",
777 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image 0x%" PRIx64
778 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
779 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
780 func_name, i, entry.index, HandleToUint64(img_barrier->image), range.aspectMask, range.baseMipLevel,
781 range.levelCount, range.baseArrayLayer, range.layerCount, string_VkImageLayout(img_barrier->oldLayout),
782 string_VkImageLayout(entry.barrier->newLayout));
783 }
784 entry = new_entry;
785 } else {
786 subres_map[img_barrier->subresourceRange] = new_entry;
787 }
788 } else {
789 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
790 }
791 }
792
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600793 auto image_state = GetImageState(device_data, img_barrier->image);
794 if (image_state) {
795 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
796 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
797 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
798
799 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
800 if (image_state->layout_locked) {
801 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600802 skip |= log_msg(
803 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Young9d1ac312018-05-21 16:28:27 -0600804 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100805 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600806 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Kraus13c98a62017-12-09 00:22:39 +0100807 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600808 string_VkImageLayout(img_barrier->newLayout));
809 }
810 }
811
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600812 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600813 // For a Depth/Stencil image both aspects MUST be set
814 if (FormatIsDepthAndStencil(image_create_info->format)) {
815 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
816 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
817 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600818 skip |=
819 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -0600820 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image),
821 "VUID-VkImageMemoryBarrier-image-01207",
Mark Lobodzinski88529492018-04-01 10:38:15 -0600822 "%s: Image barrier 0x%p references image 0x%" PRIx64
823 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
824 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
825 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600826 }
827 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600828 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
829 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700830
Mike Weiblen62d08a32017-03-07 22:18:27 -0700831 for (uint32_t j = 0; j < level_count; j++) {
832 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
833 for (uint32_t k = 0; k < layer_count; k++) {
834 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600835 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
836 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
837 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
838 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700839 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
840 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
841 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
842 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
843 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
844 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
845 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
846 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700847 }
848 }
849 }
850 return skip;
851}
852
Chris Forbes4de4b132017-08-21 11:27:08 -0700853static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600854 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700855
856 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600857 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700858}
859
John Zulauf6b4aae82018-05-09 13:03:36 -0600860template <typename Barrier>
861bool ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
862 uint32_t barrier_count, const Barrier *barriers) {
863 using BarrierRecord = QFOTransferBarrier<Barrier>;
864 bool skip = false;
865 const auto report_data = core_validation::GetReportData(device_data);
866 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
867 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
868 const char *barrier_name = BarrierRecord::BarrierName();
869 const char *handle_name = BarrierRecord::HandleName();
870 const char *transfer_type = nullptr;
871 for (uint32_t b = 0; b < barrier_count; b++) {
872 if (!IsTransferOp(&barriers[b])) continue;
873 const BarrierRecord *barrier_record = nullptr;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600874 if (IsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600875 const auto found = barrier_sets.release.find(barriers[b]);
876 if (found != barrier_sets.release.cend()) {
877 barrier_record = &(*found);
878 transfer_type = "releasing";
879 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600880 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
881 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600882 const auto found = barrier_sets.acquire.find(barriers[b]);
883 if (found != barrier_sets.acquire.cend()) {
884 barrier_record = &(*found);
885 transfer_type = "acquiring";
886 }
887 }
888 if (barrier_record != nullptr) {
889 skip |=
890 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
891 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
892 "%s: %s at index %" PRIu32 " %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
893 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
894 func_name, barrier_name, b, transfer_type, handle_name, HandleToUint64(barrier_record->handle),
895 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
896 }
897 }
898 return skip;
899}
900
901template <typename Barrier>
902void RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
903 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
904 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
905 for (uint32_t b = 0; b < barrier_count; b++) {
906 if (!IsTransferOp(&barriers[b])) continue;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600907 if (IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600908 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600909 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
910 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600911 barrier_sets.acquire.emplace(barriers[b]);
912 }
913 }
914}
915
916bool ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
917 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
918 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
919 bool skip = false;
920 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
921 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
922 return skip;
923}
924
925void RecordBarriersQFOTransfers(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
926 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
927 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
928 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
929 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
930}
931
932template <typename BarrierRecord, typename Scoreboard>
933static bool ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
934 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
935 // Record to the scoreboard or report that we have a duplication
936 bool skip = false;
937 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
938 if (!inserted.second && inserted.first->second != cb_state) {
939 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
940 skip = log_msg(
941 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
942 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
943 "%s: %s %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
944 " duplicates existing barrier submitted in this batch from command buffer 0x%" PRIx64 ".",
945 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(), HandleToUint64(barrier.handle),
946 barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex, HandleToUint64(inserted.first->second));
947 }
948 return skip;
949}
950
951template <typename Barrier>
952static bool ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
953 QFOTransferCBScoreboards<Barrier> *scoreboards) {
954 using BarrierRecord = QFOTransferBarrier<Barrier>;
955 using TypeTag = typename BarrierRecord::Tag;
956 bool skip = false;
957 const auto report_data = core_validation::GetReportData(device_data);
958 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
959 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
960 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
961 const char *barrier_name = BarrierRecord::BarrierName();
962 const char *handle_name = BarrierRecord::HandleName();
963 // No release should have an extant duplicate (WARNING)
964 for (const auto &release : cb_barriers.release) {
965 // Check the global pending release barriers
966 const auto set_it = global_release_barriers.find(release.handle);
967 if (set_it != global_release_barriers.cend()) {
968 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
969 const auto found = set_for_handle.find(release);
970 if (found != set_for_handle.cend()) {
971 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
972 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
973 "%s: %s releasing queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
974 " to dstQueueFamilyIndex %" PRIu32
975 " duplicates existing barrier queued for execution, without intervening acquire operation.",
976 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(found->handle),
977 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
978 }
979 }
980 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
981 }
982 // Each acquire must have a matching release (ERROR)
983 for (const auto &acquire : cb_barriers.acquire) {
984 const auto set_it = global_release_barriers.find(acquire.handle);
985 bool matching_release_found = false;
986 if (set_it != global_release_barriers.cend()) {
987 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
988 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
989 }
990 if (!matching_release_found) {
991 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
992 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Petr Krausfd505102018-12-17 15:18:01 +0100993 "%s: in submitted command buffer %s acquiring ownership of %s (0x%" PRIx64
John Zulauf6b4aae82018-05-09 13:03:36 -0600994 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
995 " has no matching release barrier queued for execution.",
996 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(acquire.handle),
997 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
998 }
999 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1000 }
1001 return skip;
1002}
1003
1004bool ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
1005 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
1006 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
1007 bool skip = false;
1008 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
1009 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
1010 return skip;
1011}
1012
1013template <typename Barrier>
1014static void RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1015 using BarrierRecord = QFOTransferBarrier<Barrier>;
1016 using TypeTag = typename BarrierRecord::Tag;
1017 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
1018 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1019 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
1020
1021 // Add release barriers from this submit to the global map
1022 for (const auto &release : cb_barriers.release) {
1023 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1024 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1025 global_release_barriers[release.handle].insert(release);
1026 }
1027
1028 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1029 for (const auto &acquire : cb_barriers.acquire) {
1030 // NOTE: We're not using [] because we don't want to create entries for missing releases
1031 auto set_it = global_release_barriers.find(acquire.handle);
1032 if (set_it != global_release_barriers.end()) {
1033 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1034 set_for_handle.erase(acquire);
1035 if (set_for_handle.size() == 0) { // Clean up empty sets
1036 global_release_barriers.erase(set_it);
1037 }
1038 }
1039 }
1040}
1041
1042void RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1043 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1044 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1045}
1046
1047// Remove the pending QFO release records from the global set
1048// Note that the type of the handle argument constrained to match Barrier type
1049// The defaulted BarrierRecord argument allows use to declare the type once, but is not intended to be specified by the caller
1050template <typename Barrier, typename BarrierRecord = QFOTransferBarrier<Barrier>>
1051static void EraseQFOReleaseBarriers(layer_data *device_data, const typename BarrierRecord::HandleType &handle) {
1052 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1053 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, typename BarrierRecord::Tag());
1054 global_release_barriers.erase(handle);
1055}
1056
1057// Avoid making the template globally visible by exporting the one instance of it we need.
1058void EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
1059 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1060}
1061
Chris Forbes399a6782017-08-18 15:00:48 -07001062void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001063 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001064 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1065 auto mem_barrier = &pImgMemBarriers[i];
1066 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001067
Chris Forbes4de4b132017-08-21 11:27:08 -07001068 // For ownership transfers, the barrier is specified twice; as a release
1069 // operation on the yielding queue family, and as an acquire operation
1070 // on the acquiring queue family. This barrier may also include a layout
1071 // transition, which occurs 'between' the two operations. For validation
1072 // purposes it doesn't seem important which side performs the layout
1073 // transition, but it must not be performed twice. We'll arbitrarily
1074 // choose to perform it as part of the acquire operation.
1075 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
1076 continue;
1077 }
1078
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001079 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
1080 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1081 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1082
Dave Houltonb3f4b282018-02-22 16:25:16 -07001083 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1084 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1085 // for all (potential) layer sub_resources.
1086 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1087 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1088 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1089 }
1090
Tony-LunarG0d27b302018-10-08 09:26:21 -06001091 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1092 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
1093 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1094 if (FormatIsMultiplane(image_create_info->format)) {
1095 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1096 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1097 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1098 if (FormatPlaneCount(image_create_info->format) > 2) {
1099 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1100 }
1101 }
1102 }
1103 }
1104
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001105 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001106 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001107 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001108 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Tony-LunarG0d27b302018-10-08 09:26:21 -06001109 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1110 VK_IMAGE_ASPECT_COLOR_BIT);
1111 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1112 VK_IMAGE_ASPECT_DEPTH_BIT);
1113 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1114 VK_IMAGE_ASPECT_STENCIL_BIT);
1115 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1116 VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001117 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001118 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1119 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1120 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1121 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1122 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1123 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001124 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001125 }
1126 }
1127 }
1128}
1129
Tobin Ehlisc8266452017-04-07 12:20:30 -06001130bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001131 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07001132 const char *caller, const std::string &layout_invalid_msg_code, const std::string &layout_mismatch_msg_code,
1133 bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001134 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001135 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001136 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001137
1138 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1139 uint32_t layer = i + subLayers.baseArrayLayer;
1140 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1141 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001142 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1143 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001144 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001145 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1146 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1147 "%s: Cannot use image 0x%" PRIx64
1148 " (layer=%u mip=%u) with specific layout %s that doesn't match the actual current layout %s.",
1149 caller, HandleToUint64(image), layer, subLayers.mipLevel, string_VkImageLayout(explicit_layout),
1150 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001151 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001152 }
1153 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001154 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1155 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1156 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001157 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1158 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001159 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001160 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001161 kVUID_Core_DrawState_InvalidImageLayout,
Petr Kraus13c98a62017-12-09 00:22:39 +01001162 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
1163 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001164 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001165 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001166 if (image_state->shared_presentable) {
1167 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001168 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1169 layout_invalid_msg_code,
1170 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1171 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001172 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001173 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001174 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001175 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001176 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton7df30962018-05-17 19:45:57 -07001177 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001178 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1179 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001180 }
1181 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001182 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001183}
1184
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001185void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
1186 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001187 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001188 if (!renderPass) return;
1189
Tobias Hectorbbb12282018-10-22 15:17:59 +01001190 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001191 if (framebuffer_state) {
1192 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -06001193 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
1194 if (view_state) {
1195 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
1196 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001197 }
1198 }
1199}
Dave Houltone19e20d2018-02-02 16:32:41 -07001200
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001201#ifdef VK_USE_PLATFORM_ANDROID_KHR
1202// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1203// This could also move into a seperate core_validation_android.cpp file... ?
1204
1205//
1206// AHB-specific validation within non-AHB APIs
1207//
1208bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1209 const VkImageCreateInfo *create_info) {
1210 bool skip = false;
1211
1212 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1213 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001214 if (0 != ext_fmt_android->externalFormat) {
1215 if (VK_FORMAT_UNDEFINED != create_info->format) {
1216 skip |=
1217 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1218 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001219 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001220 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1221 }
1222
1223 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1224 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1225 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001226 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001227 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1228 }
1229
1230 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1231 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1232 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001233 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001234 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1235 }
1236
1237 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1238 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1239 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001240 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001241 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1242 }
1243 }
1244
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001245 auto ahb_formats = GetAHBExternalFormatsSet(device_data);
1246 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1247 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1248 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001249 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001250 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1251 }
1252 }
1253
Dave Houltond9611312018-11-19 17:03:36 -07001254 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001255 if (VK_FORMAT_UNDEFINED == create_info->format) {
1256 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1257 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001258 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001259 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1260 }
1261 }
1262
1263 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1264 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1265 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001266 skip |=
1267 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1268 "VUID-VkImageCreateInfo-pNext-02393",
1269 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1270 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1271 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001272 }
1273
1274 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1275 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1276 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001277 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001278 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1279 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1280 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1281 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001282 }
1283
1284 return skip;
1285}
1286
1287void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
1288 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1289 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1290 is_node->imported_ahb = true;
1291 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001292 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1293 if (ext_fmt_android) {
1294 is_node->has_ahb_format = true;
1295 is_node->ahb_format = ext_fmt_android->externalFormat;
1296 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001297}
1298
1299bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
1300 bool skip = false;
1301 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houltond3e046d2018-11-28 13:08:09 -07001302 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
1303
1304 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001305 if (VK_FORMAT_UNDEFINED != create_info->format) {
1306 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1307 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1308 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1309 "format member is %s.",
1310 string_VkFormat(create_info->format));
1311 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001312
Dave Houltond9611312018-11-19 17:03:36 -07001313 // Chain must include a compatible ycbcr conversion
1314 bool conv_found = false;
1315 uint64_t external_format = 0;
1316 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1317 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001318 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
1319 auto fmap = GetYcbcrConversionFormatMap(device_data);
Dave Houltond9611312018-11-19 17:03:36 -07001320 if (fmap->find(conv_handle) != fmap->end()) {
1321 conv_found = true;
1322 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001323 }
Dave Houltond9611312018-11-19 17:03:36 -07001324 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001325 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001326 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond9611312018-11-19 17:03:36 -07001327 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1328 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1329 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1330 }
1331
1332 // Errors in create_info swizzles
1333 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1334 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1335 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1336 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1337 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1338 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1339 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1340 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001341 }
1342 }
Dave Houltond9611312018-11-19 17:03:36 -07001343
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001344 return skip;
1345}
1346
1347bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
1348 bool skip = false;
1349 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1350
1351 IMAGE_STATE *image_state = GetImageState(device_data, image);
1352 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1353 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1354 "VUID-vkGetImageSubresourceLayout-image-01895",
1355 "vkGetImageSubresourceLayout: Attempt to query layout from an image created with "
1356 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1357 "bound to memory.");
1358 }
1359 return skip;
1360}
1361
1362#else
1363
1364bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1365 const VkImageCreateInfo *create_info) {
1366 return false;
1367}
1368
1369void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
1370
1371bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
1372
1373bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
1374
1375#endif // VK_USE_PLATFORM_ANDROID_KHR
1376
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001377bool PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
1378 VkImage *pImage) {
1379 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), core_validation::layer_data_map);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001380 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001381 const debug_report_data *report_data = GetReportData(device_data);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001382
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001383 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1384 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1385 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1386 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1387 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1388 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001389 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001390 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001391 }
1392
Dave Houlton130c0212018-01-29 13:39:56 -07001393 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001394 skip |= log_msg(
1395 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1396 "VUID-VkImageCreateInfo-flags-00949",
1397 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set");
Dave Houlton130c0212018-01-29 13:39:56 -07001398 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001399
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07001400 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001401 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1402 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1403 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001404 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001405 "VUID-VkImageCreateInfo-usage-00964",
1406 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1407 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001408 }
1409
1410 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001411 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001412 "VUID-VkImageCreateInfo-usage-00965",
1413 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1414 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001415 }
1416
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001417 VkImageFormatProperties format_limits = {};
1418 VkResult res = GetPDImageFormatProperties(device_data, pCreateInfo, &format_limits);
1419 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1420 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1421 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1422 string_VkFormat(pCreateInfo->format));
1423 } else {
1424 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1425 const char *format_string = string_VkFormat(pCreateInfo->format);
1426 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1427 "VUID-VkImageCreateInfo-mipLevels-02255",
1428 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1429 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1430 }
Dave Houlton130c0212018-01-29 13:39:56 -07001431
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001432 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1433 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1434 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
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 Lobodzinskibdc3b022017-04-24 09:11:35 -06001493 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001494}
1495
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001496void PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
1497 VkImage *pImage) {
1498 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), core_validation::layer_data_map);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001499 IMAGE_LAYOUT_NODE image_state;
1500 image_state.layout = pCreateInfo->initialLayout;
1501 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001502 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
1503 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1504 RecordCreateImageANDROID(pCreateInfo, is_node);
1505 }
1506 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001507 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001508 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1509 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001510}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001511
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001512bool PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1513 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
1514 IMAGE_STATE *image_state = core_validation::GetImageState(device_data, image);
1515 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001516 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001517 if (image_state) {
1518 skip |= core_validation::ValidateObjectNotInUse(device_data, image_state, obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001519 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001520 }
1521 return skip;
1522}
1523
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001524void PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1525 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
1526 IMAGE_STATE *image_state = core_validation::GetImageState(device_data, image);
1527 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001528 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001529 // Clean up memory mapping, bindings and range references for image
1530 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001531 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001532 if (mem_info) {
1533 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1534 }
1535 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001536 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001537 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001538 // Remove image from imageMap
1539 core_validation::GetImageMap(device_data)->erase(image);
1540 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1541 core_validation::GetImageSubresourceMap(device_data);
1542
1543 const auto &sub_entry = imageSubresourceMap->find(image);
1544 if (sub_entry != imageSubresourceMap->end()) {
1545 for (const auto &pair : sub_entry->second) {
1546 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1547 }
1548 imageSubresourceMap->erase(sub_entry);
1549 }
1550}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001551
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001552bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001553 bool skip = false;
1554 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1555
1556 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1557 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1558 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 -06001559 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001560 }
1561
Dave Houlton1d2022c2017-03-29 11:43:58 -06001562 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001563 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1564 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 -06001565 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001566 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001567 char const str[] = "vkCmdClearColorImage called with compressed image.";
1568 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 -06001569 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001570 }
1571
1572 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1573 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1574 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 -06001575 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001576 }
1577 return skip;
1578}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001579
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001580uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1581 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1582 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001583 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001584 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001585 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001586 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001587}
1588
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001589uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1590 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1591 uint32_t array_layer_count = range->layerCount;
1592 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1593 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001594 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001595 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001596}
1597
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001598bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001599 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1600 bool skip = false;
1601 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1602
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001603 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1604 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001605
1606 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1607 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001608 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1609 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001610 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 -06001611 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001612 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1613 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001614 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001615 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001616 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001617 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 -06001618 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001619 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1620 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001621
1622 } else {
1623 if (image_state->shared_presentable) {
1624 skip |= log_msg(
1625 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,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001627 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1628 string_VkImageLayout(dest_image_layout));
1629 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001630 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001631 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001632 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001633 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001634 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001635 } else {
1636 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1637 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001638 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 -06001639 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001640 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1641 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001642 }
1643 }
1644
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001645 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1646 uint32_t level = level_index + range.baseMipLevel;
1647 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1648 uint32_t layer = layer_index + range.baseArrayLayer;
1649 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001650 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001651 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001652 if (node.layout != dest_image_layout) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001653 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001654 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001655 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001656 } else {
1657 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1658 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001659 skip |=
1660 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1661 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1662 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001663 }
1664 }
1665 }
1666 }
1667
1668 return skip;
1669}
1670
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001671void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1672 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001673 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1674 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1675 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001676
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001677 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1678 uint32_t level = level_index + range.baseMipLevel;
1679 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1680 uint32_t layer = layer_index + range.baseArrayLayer;
1681 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001682 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001683 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1684 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 -07001685 }
1686 }
1687 }
1688}
1689
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001690bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001691 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1692 bool skip = false;
1693 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001694 auto cb_node = GetCBNode(dev_data, commandBuffer);
1695 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001696 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001697 skip |=
1698 ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001699 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001700 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001701 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001702 if (GetApiVersion(dev_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001703 skip |=
1704 ValidateImageFormatFeatureFlags(dev_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001705 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001706 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001707 skip |= InsideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001708 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001709 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001710 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001711 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001712 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001713 }
1714 }
1715 return skip;
1716}
1717
1718// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001719void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001720 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001721 auto cb_node = GetCBNode(dev_data, commandBuffer);
1722 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001723 if (cb_node && image_state) {
1724 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001725 for (uint32_t i = 0; i < rangeCount; ++i) {
1726 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1727 }
1728 }
1729}
1730
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001731bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1732 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001733 const VkImageSubresourceRange *pRanges) {
1734 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001735 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1736
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001737 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001738 auto cb_node = GetCBNode(device_data, commandBuffer);
1739 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001740 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001741 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1742 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001743 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001744 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001745 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001746 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1747 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001748 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1749 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001750 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001751 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001752 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001753 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001754 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001755 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001756 skip |=
1757 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001758 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001759 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1760 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001761 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001762 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1763 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001764 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 -06001765 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001766 }
1767 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001768 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001769 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001770 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 -06001771 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001772 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001773 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1774 char const str[] =
1775 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1776 "set.";
1777 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 -06001778 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001779 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001780 }
1781 return skip;
1782}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001783
1784// Returns true if [x, xoffset] and [y, yoffset] overlap
1785static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1786 bool result = false;
1787 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1788 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1789
1790 if (intersection_max > intersection_min) {
1791 result = true;
1792 }
1793 return result;
1794}
1795
Dave Houltonc991cc92018-03-06 11:08:51 -07001796// Returns true if source area of first copy region intersects dest area of second region
1797// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1798static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001799 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001800
Dave Houltonc991cc92018-03-06 11:08:51 -07001801 // Separate planes within a multiplane image cannot intersect
1802 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001803 return result;
1804 }
1805
Dave Houltonc991cc92018-03-06 11:08:51 -07001806 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1807 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1808 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001809 result = true;
1810 switch (type) {
1811 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001812 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001813 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001814 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001815 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001816 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001817 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001818 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001819 break;
1820 default:
1821 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1822 assert(false);
1823 }
1824 }
1825 return result;
1826}
1827
Dave Houltonfc1a4052017-04-27 14:32:45 -06001828// Returns non-zero if offset and extent exceed image extents
1829static const uint32_t x_bit = 1;
1830static const uint32_t y_bit = 2;
1831static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001832static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001833 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001834 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001835 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1836 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001837 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001838 }
1839 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1840 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001841 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001842 }
1843 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1844 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001845 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001846 }
1847 return result;
1848}
1849
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001850// Test if two VkExtent3D structs are equivalent
1851static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1852 bool result = true;
1853 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1854 (extent->depth != other_extent->depth)) {
1855 result = false;
1856 }
1857 return result;
1858}
1859
Dave Houltonee281a52017-12-08 13:51:02 -07001860// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1861// Destination image texel extents must be adjusted by block size for the dest validation checks
1862VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1863 VkExtent3D adjusted_extent = extent;
1864 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1865 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1866 adjusted_extent.width /= block_size.width;
1867 adjusted_extent.height /= block_size.height;
1868 adjusted_extent.depth /= block_size.depth;
1869 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1870 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1871 adjusted_extent.width *= block_size.width;
1872 adjusted_extent.height *= block_size.height;
1873 adjusted_extent.depth *= block_size.depth;
1874 }
1875 return adjusted_extent;
1876}
1877
Dave Houlton6f9059e2017-05-02 17:15:13 -06001878// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001879static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1880 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001881
1882 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001883 if (mip >= img->createInfo.mipLevels) {
1884 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001885 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001886
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001887 // 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 -06001888 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001889
Dave Houltone48cd112019-01-03 17:01:18 -07001890 // If multi-plane, adjust per-plane extent
1891 if (FormatIsMultiplane(img->createInfo.format)) {
1892 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1893 extent.width /= divisors.width;
1894 extent.height /= divisors.height;
1895 }
1896
Jeff Bolzef40fec2018-09-01 22:04:34 -05001897 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1898 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001899 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001900 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1901 } else {
1902 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1903 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1904 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1905 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001906
Dave Houlton6f9059e2017-05-02 17:15:13 -06001907 // Image arrays have an effective z extent that isn't diminished by mip level
1908 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001909 extent.depth = img->createInfo.arrayLayers;
1910 }
1911
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001912 return extent;
1913}
1914
1915// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001916static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001917 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1918}
1919
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001920// Test if the extent argument has any dimensions set to 0.
1921static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1922 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1923}
1924
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001925// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1926static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1927 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1928 VkExtent3D granularity = {0, 0, 0};
1929 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1930 if (pPool) {
1931 granularity =
1932 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001933 if (FormatIsCompressed(img->createInfo.format)) {
1934 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001935 granularity.width *= block_size.width;
1936 granularity.height *= block_size.height;
1937 }
1938 }
1939 return granularity;
1940}
1941
1942// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1943static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1944 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001945 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1946 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001947 valid = false;
1948 }
1949 return valid;
1950}
1951
1952// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1953static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001954 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001955 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001956 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1957 bool skip = false;
1958 VkExtent3D offset_extent = {};
1959 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1960 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1961 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001962 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001963 // 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 -07001964 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001965 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 -04001966 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001967 "%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 "
1968 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001969 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001970 }
1971 } else {
1972 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1973 // integer multiples of the image transfer granularity.
1974 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001975 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 -04001976 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001977 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1978 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001979 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1980 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001981 }
1982 }
1983 return skip;
1984}
1985
1986// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1987static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1988 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001989 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001990 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001991 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1992 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001993 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001994 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1995 // subresource extent.
1996 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001997 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 -04001998 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001999 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2000 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2001 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2002 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002003 }
2004 } else {
2005 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2006 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2007 // subresource extent dimensions.
2008 VkExtent3D offset_extent_sum = {};
2009 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2010 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2011 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002012 bool x_ok = true;
2013 bool y_ok = true;
2014 bool z_ok = true;
2015 switch (image_type) {
2016 case VK_IMAGE_TYPE_3D:
2017 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2018 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002019 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002020 case VK_IMAGE_TYPE_2D:
2021 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2022 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002023 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002024 case VK_IMAGE_TYPE_1D:
2025 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2026 (subresource_extent->width == offset_extent_sum.width));
2027 break;
2028 default:
2029 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2030 assert(false);
2031 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002032 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002033 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002034 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002035 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2036 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2037 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2038 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2039 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2040 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002041 }
2042 }
2043 return skip;
2044}
2045
Cort Strattonff1542a2018-05-27 10:49:28 -07002046bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
2047 const uint32_t i, const char *function, const char *member, const std::string &vuid) {
2048 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2049 bool skip = false;
2050 if (mip_level >= img->createInfo.mipLevels) {
2051 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2052 HandleToUint64(cb_node->commandBuffer), vuid,
2053 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
2054 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
2055 }
2056 return skip;
2057}
2058
2059bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2060 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
2061 const char *member, const std::string &vuid) {
2062 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2063 bool skip = false;
2064 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2065 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2066 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2067 HandleToUint64(cb_node->commandBuffer), vuid,
2068 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2069 "%u, but provided image %" PRIx64 " has %u array layers.",
2070 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
2071 }
2072 return skip;
2073}
2074
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002075// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002076bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2077 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Dave Houltone0969282018-05-23 15:54:31 -06002078 const uint32_t i, const char *function, const std::string &vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002079 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002080 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2081 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2082 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2083 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2084 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002085 return skip;
2086}
2087
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002088// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002089bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002090 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2091 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002092 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002093 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002094 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002095 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2096 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002097 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002098 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002099 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002100 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002101
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002102 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002103 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002104 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2105 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002106 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002107 const VkExtent3D dest_effective_extent =
2108 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002109 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002110 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002111 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002112 return skip;
2113}
2114
Dave Houlton6f9059e2017-05-02 17:15:13 -06002115// Validate contents of a VkImageCopy struct
2116bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
2117 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
2118 bool skip = false;
2119
2120 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002121 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002122
2123 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002124 const VkExtent3D src_copy_extent = region.extent;
2125 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002126 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2127
Dave Houlton6f9059e2017-05-02 17:15:13 -06002128 bool slice_override = false;
2129 uint32_t depth_slices = 0;
2130
2131 // Special case for copying between a 1D/2D array and a 3D image
2132 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2133 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002134 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002135 slice_override = (depth_slices != 1);
2136 } 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 -07002137 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002138 slice_override = (depth_slices != 1);
2139 }
2140
2141 // Do all checks on source image
2142 //
2143 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002144 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2145 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 -06002146 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002147 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002148 "be 0 and 1, respectively.",
2149 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002150 }
2151 }
2152
Dave Houlton533be9f2018-03-26 17:08:30 -06002153 // VUID-VkImageCopy-srcImage-01785
2154 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2155 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002156 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002157 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002158 "these must be 0 and 1, respectively.",
2159 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002160 }
2161
Dave Houlton533be9f2018-03-26 17:08:30 -06002162 // VUID-VkImageCopy-srcImage-01787
2163 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2164 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 -06002165 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002166 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2167 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002168 }
2169
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002170 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002171 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002172 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002173 skip |=
2174 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002175 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002176 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002177 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2178 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002179 }
2180 }
2181 } else { // Pre maint 1
2182 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002183 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002184 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 -06002185 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002186 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2187 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002188 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2189 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002190 }
2191 }
2192 }
2193
Dave Houltonc991cc92018-03-06 11:08:51 -07002194 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2195 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
2196 if (FormatIsCompressed(src_state->createInfo.format) ||
2197 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002198 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002199 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002200 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2201 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2202 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002203 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002204 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 -07002205 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002206 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002207 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002208 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002209 }
2210
Dave Houlton94a00372017-12-14 15:08:47 -07002211 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002212 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2213 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002214 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002215 skip |=
2216 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002217 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002218 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002219 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002220 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002221 }
2222
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002223 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002224 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2225 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002226 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227 skip |=
2228 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002229 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002230 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002231 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002232 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002233 }
2234
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002235 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002236 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2237 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002238 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002239 skip |=
2240 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002241 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002242 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002243 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002244 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002245 }
2246 } // Compressed
2247
2248 // Do all checks on dest image
2249 //
2250 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002251 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002252 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 -06002253 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002254 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002255 "these must be 0 and 1, respectively.",
2256 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002257 }
2258 }
2259
Dave Houlton533be9f2018-03-26 17:08:30 -06002260 // VUID-VkImageCopy-dstImage-01786
2261 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2262 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 -06002263 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002264 "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 -06002265 "and 1, respectively.",
2266 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002267 }
2268
2269 // VUID-VkImageCopy-dstImage-01788
2270 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2271 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002272 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002273 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2274 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002275 }
2276
2277 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002278 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002279 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 -06002280 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002281 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002282 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2283 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002284 }
2285 }
2286 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002287 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002288 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002289 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002290 skip |=
2291 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002292 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002293 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002294 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2295 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002296 }
2297 }
2298 } else { // Pre maint 1
2299 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002300 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002301 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 -06002302 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002303 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2304 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002305 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2306 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002307 }
2308 }
2309 }
2310
Dave Houltonc991cc92018-03-06 11:08:51 -07002311 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2312 if (FormatIsCompressed(dst_state->createInfo.format) ||
2313 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002314 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002315
2316 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002317 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2318 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2319 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002320 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002321 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 -07002322 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002323 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002324 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002325 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002326 }
2327
Dave Houlton94a00372017-12-14 15:08:47 -07002328 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002329 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2330 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002331 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002332 skip |=
2333 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002334 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002335 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002336 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002337 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002338 }
2339
Dave Houltonee281a52017-12-08 13:51:02 -07002340 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2341 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2342 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002343 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002344 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 -07002345 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002346 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2347 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002348 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002349 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002350 }
2351
Dave Houltonee281a52017-12-08 13:51:02 -07002352 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2353 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2354 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002355 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002356 skip |=
2357 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002358 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002359 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002360 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002361 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002362 }
2363 } // Compressed
2364 }
2365 return skip;
2366}
2367
Dave Houltonc991cc92018-03-06 11:08:51 -07002368// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2369bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2370 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2371 bool skip = false;
2372 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2373
2374 // Neither image is multiplane
2375 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2376 // If neither image is multi-plane the aspectMask member of src and dst must match
2377 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2378 std::stringstream ss;
2379 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
2380 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2381 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 -06002382 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002383 }
2384 } else {
2385 // Source image multiplane checks
2386 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2387 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2388 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2389 std::stringstream ss;
2390 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2391 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 -06002392 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002393 }
2394 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2395 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2396 std::stringstream ss;
2397 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2398 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002399 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002400 }
2401 // Single-plane to multi-plane
2402 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2403 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2404 std::stringstream ss;
2405 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2406 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 -06002407 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002408 }
2409
2410 // Dest image multiplane checks
2411 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2412 aspect = region.dstSubresource.aspectMask;
2413 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2414 std::stringstream ss;
2415 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2416 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 -06002417 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002418 }
2419 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2420 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2421 std::stringstream ss;
2422 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2423 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002424 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002425 }
2426 // Multi-plane to single-plane
2427 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2428 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2429 std::stringstream ss;
2430 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2431 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 -06002432 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002433 }
2434 }
2435
2436 return skip;
2437}
2438
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002439bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002440 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2441 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002442 bool skip = false;
2443 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002444 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
2445
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002446 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2447
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002448 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002449 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002450
2451 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2452 VkExtent3D src_copy_extent = region.extent;
2453 VkExtent3D dst_copy_extent =
2454 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2455
Dave Houlton6f9059e2017-05-02 17:15:13 -06002456 bool slice_override = false;
2457 uint32_t depth_slices = 0;
2458
2459 // Special case for copying between a 1D/2D array and a 3D image
2460 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2461 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2462 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002463 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002464 slice_override = (depth_slices != 1);
2465 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2466 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002467 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002468 slice_override = (depth_slices != 1);
2469 }
2470
Cort Strattond619a302018-05-17 19:46:32 -07002471 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2472 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002473 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2474 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2475 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2476 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2477 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2478 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2479 "VUID-vkCmdCopyImage-srcSubresource-01698");
2480 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2481 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2482 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002483
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002484 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002485 // No chance of mismatch if we're overriding depth slice count
2486 if (!slice_override) {
2487 // The number of depth slices in srcSubresource and dstSubresource must match
2488 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2489 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002490 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2491 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002492 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002493 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2494 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002495 if (src_slices != dst_slices) {
2496 std::stringstream ss;
2497 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
2498 << "] do not match";
2499 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 -06002500 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002501 }
2502 }
2503 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002504 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002505 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002506 std::stringstream ss;
2507 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
2508 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002509 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 -06002510 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002511 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002512 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002513
Dave Houltonc991cc92018-03-06 11:08:51 -07002514 // Do multiplane-specific checks, if extension enabled
2515 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2516 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2517 }
2518
Dave Houltonf5217612018-02-02 16:18:52 -07002519 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2520 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2521 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2522 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
2523 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 -06002524 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002525 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002526 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002527
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002528 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002529 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002530 std::stringstream ss;
2531 ss << "vkCmdCopyImage: pRegion[" << i
2532 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2533 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 -06002534 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002535 }
2536
2537 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002538 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002539 std::stringstream ss;
2540 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2541 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-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002543 }
2544
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002545 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2546 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2547 // 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 -07002548 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2549 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002550 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002551 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
2552 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2553 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2554 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002555 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-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002557 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002558
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002559 // 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 -07002560 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2561 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002562 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002563 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2564 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2565 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2566 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002567 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002568 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002569 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002570 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002571
Dave Houltonfc1a4052017-04-27 14:32:45 -06002572 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002573 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2574 if (slice_override) src_copy_extent.depth = depth_slices;
2575 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002576 if (extent_check & x_bit) {
2577 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 -06002578 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002579 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002580 "width [%1d].",
2581 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002582 }
2583
2584 if (extent_check & y_bit) {
2585 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 -06002586 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002587 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002588 "height [%1d].",
2589 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002590 }
2591 if (extent_check & z_bit) {
2592 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 -06002593 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002594 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002595 "depth [%1d].",
2596 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002597 }
2598
Dave Houltonee281a52017-12-08 13:51:02 -07002599 // Adjust dest extent if necessary
2600 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2601 if (slice_override) dst_copy_extent.depth = depth_slices;
2602
2603 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002604 if (extent_check & x_bit) {
2605 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002606 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002607 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002608 "width [%1d].",
2609 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002610 }
2611 if (extent_check & y_bit) {
2612 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002613 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002614 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002615 "height [%1d].",
2616 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002617 }
2618 if (extent_check & z_bit) {
2619 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002620 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002621 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002622 "depth [%1d].",
2623 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002624 }
2625
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2627 // must not overlap in memory
2628 if (src_image_state->image == dst_image_state->image) {
2629 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002630 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2631 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002632 std::stringstream ss;
2633 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2634 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002635 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002636 }
2637 }
2638 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002639 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002640
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002641 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2642 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2643 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002644 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002645 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2646 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002647 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002648 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002649 }
2650 } else {
Tony-LunarG7482ca92018-10-01 14:20:22 -06002651 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, region_count, regions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002652 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2653 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002654 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002655 }
2656 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002657
Dave Houlton33c22b72017-02-28 13:16:02 -07002658 // Source and dest image sample counts must match
2659 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2660 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2661 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002662 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002663 }
2664
Dave Houltond8ed0212018-05-16 17:18:24 -06002665 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2666 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002667 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002668 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2669 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2670 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2671 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002672 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002673 skip |=
2674 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002675 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002676 skip |=
2677 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002678 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002679 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002680 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002681 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2682 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002683 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002684 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002685 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07002686 const std::string invalid_src_layout_vuid =
2687 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2688 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2689 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2690 const std::string invalid_dst_layout_vuid =
2691 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2692 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2693 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002694 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002695 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002696 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2697 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002698 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002699 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2700 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002701 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2702 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002703 }
2704
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002705 return skip;
2706}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002707
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002708void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002709 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2710 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2711 // Make sure that all image slices are updated to correct layout
2712 for (uint32_t i = 0; i < region_count; ++i) {
2713 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2714 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2715 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002716 // Update bindings between images and cmd buffer
2717 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2718 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002719}
2720
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002721// Returns true if sub_rect is entirely contained within rect
2722static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2723 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2724 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2725 return false;
2726 return true;
2727}
2728
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002729bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2730 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002731 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002732 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2733
2734 bool skip = false;
2735 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002736 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002737 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002738 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002739 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002740 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002741 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2742 // 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 -07002743 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2744 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002745 skip |= log_msg(
2746 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002747 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002748 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2749 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2750 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002751 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002752 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002753 }
2754
2755 // Validate that attachment is in reference list of active subpass
2756 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002757 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2758 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002759 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002760
2761 for (uint32_t i = 0; i < attachmentCount; i++) {
2762 auto clear_desc = &pAttachments[i];
2763 VkImageView image_view = VK_NULL_HANDLE;
2764
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002765 if (0 == clear_desc->aspectMask) {
2766 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 -06002767 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002768 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2769 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 -06002770 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002771 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002772 if ((subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment != VK_ATTACHMENT_UNUSED) &&
2773 (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002774 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002775 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2776 "vkCmdClearAttachments() color attachment index %d is not VK_ATTACHMENT_UNUSED and is out of "
2777 "range for active subpass %d.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002778 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002779 } else {
2780 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002781 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002782 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002783 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2784 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2785 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002786 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002787 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 -06002788 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002789 }
2790 } else { // Must be depth and/or stencil
2791 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2792 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002793 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002794 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 -06002795 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002796 }
2797 if (!subpass_desc->pDepthStencilAttachment ||
2798 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2799 skip |= log_msg(
2800 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002801 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002802 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002803 } else {
2804 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2805 }
2806 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002807 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002808 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002809 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002810 // The rectangular region specified by a given element of pRects must be contained within the render area of
2811 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002812 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2813 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2814 skip |=
2815 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002816 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002817 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002818 "the current render pass instance.",
2819 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002820 }
2821 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002822 const auto local_rect =
2823 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002824 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002825 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002826 return log_msg(
2827 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002828 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002829 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002830 "the current render pass instance.",
2831 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002832 }
2833 return false;
2834 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002835 }
2836 // The layers specified by a given element of pRects must be contained within every attachment that
2837 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002838 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002839 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2840 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002841 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 -06002842 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00017",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002843 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002844 "of pAttachment[%d].",
2845 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002846 }
2847 }
2848 }
2849 }
2850 }
2851 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002852}
2853
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002854bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Cort Stratton7df30962018-05-17 19:45:57 -07002855 VkImageLayout src_image_layout, IMAGE_STATE *dst_image_state, VkImageLayout dst_image_layout,
2856 uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002857 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002858 bool skip = false;
2859 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002860 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2861 "VUID-vkCmdResolveImage-srcImage-00256");
2862 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2863 "VUID-vkCmdResolveImage-dstImage-00258");
2864 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2865 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002866 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002867 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002868 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002869 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2870 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002871
Cort Stratton7df30962018-05-17 19:45:57 -07002872 bool hit_error = false;
2873 const std::string invalid_src_layout_vuid =
2874 (src_image_state->shared_presentable &&
2875 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2876 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2877 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2878 const std::string invalid_dst_layout_vuid =
2879 (dst_image_state->shared_presentable &&
2880 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2881 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2882 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002883 // For each region, the number of layers in the image subresource should not be zero
2884 // For each region, src and dest image aspect must be color only
2885 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002886 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2887 "srcSubresource", i);
2888 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2889 "dstSubresource", i);
Cort Stratton7df30962018-05-17 19:45:57 -07002890 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, src_image_layout,
2891 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2892 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
2893 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dst_image_layout,
2894 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2895 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002896 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2897 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2898 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2899 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2900 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2901 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2902 "VUID-vkCmdResolveImage-srcSubresource-01711");
2903 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2904 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2905 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002906
2907 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002908 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2909 skip |= log_msg(
2910 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002911 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002912 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002913 }
Cort Stratton7df30962018-05-17 19:45:57 -07002914 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002915 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2916 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2917 char const str[] =
2918 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2919 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 -06002920 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002921 }
2922 }
2923
2924 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2925 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002926 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 -06002927 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002928 }
2929 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2930 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002931 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 -06002932 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002933 }
2934 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2935 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2936 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 -06002937 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002938 }
2939 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2940 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2941 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 -06002942 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002943 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002944 } else {
2945 assert(0);
2946 }
2947 return skip;
2948}
2949
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002950void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2951 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002952 // Update bindings between images and cmd buffer
2953 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2954 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002955}
2956
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002957bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002958 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2959 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002960 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2961
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002962 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002963 if (cb_node) {
2964 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2965 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002966 if (cb_node && src_image_state && dst_image_state) {
2967 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002968 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002969 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002970 "VUID-vkCmdBlitImage-dstImage-00234");
2971 skip |=
2972 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2973 skip |=
2974 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
2975 skip |=
2976 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2977 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2978 skip |=
2979 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2980 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2981 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
2982 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002983 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002984 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002985 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002986 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04002987 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002988 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002989
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002990 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002991
Dave Houlton33c2d252017-06-09 17:08:32 -06002992 VkFormat src_format = src_image_state->createInfo.format;
2993 VkFormat dst_format = dst_image_state->createInfo.format;
2994 VkImageType src_type = src_image_state->createInfo.imageType;
2995 VkImageType dst_type = dst_image_state->createInfo.imageType;
2996
Cort Stratton186b1a22018-05-01 20:18:06 -04002997 if (VK_FILTER_LINEAR == filter) {
2998 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002999 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3000 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003001 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003002 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
3003 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003004 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003005 }
3006
3007 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3008 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 -06003009 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003010 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003011 }
3012
Dave Houlton33c2d252017-06-09 17:08:32 -06003013 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3014 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3015 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 -06003016 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003017 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003018 }
3019
3020 // Validate consistency for unsigned formats
3021 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3022 std::stringstream ss;
3023 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
3024 << "the other one must also have unsigned integer format. "
3025 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3026 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003027 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003028 }
3029
3030 // Validate consistency for signed formats
3031 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3032 std::stringstream ss;
3033 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
3034 << "the other one must also have signed integer format. "
3035 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3036 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 -06003037 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003038 }
3039
3040 // Validate filter for Depth/Stencil formats
3041 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3042 std::stringstream ss;
3043 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
3044 << "then filter must be VK_FILTER_NEAREST.";
3045 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 -06003046 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003047 }
3048
3049 // Validate aspect bits and formats for depth/stencil images
3050 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3051 if (src_format != dst_format) {
3052 std::stringstream ss;
3053 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
3054 << "stencil, the other one must have exactly the same format. "
3055 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3056 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003057 skip |=
3058 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3059 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003060 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003061 } // Depth or Stencil
3062
3063 // Do per-region checks
Cort Stratton7df30962018-05-17 19:45:57 -07003064 const std::string invalid_src_layout_vuid =
3065 (src_image_state->shared_presentable &&
3066 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3067 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3068 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3069 const std::string invalid_dst_layout_vuid =
3070 (dst_image_state->shared_presentable &&
3071 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3072 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3073 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003074 for (uint32_t i = 0; i < region_count; i++) {
3075 const VkImageBlit rgn = regions[i];
3076 bool hit_error = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06003077 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003078 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3079 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Dave Houltond8ed0212018-05-16 17:18:24 -06003080 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003081 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3082 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003083 skip |=
3084 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3085 skip |=
3086 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003087 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3088 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3089 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3090 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3091 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3092 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3093 "VUID-vkCmdBlitImage-srcSubresource-01707");
3094 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3095 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3096 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003097 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003098 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3099 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003100 std::stringstream ss;
3101 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003102 skip |=
3103 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3104 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003105 }
Dave Houlton48989f32017-05-26 15:01:46 -06003106 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3107 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003108 std::stringstream ss;
3109 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003110 skip |=
3111 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3112 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003113 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003114
3115 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003116 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003117 skip |=
3118 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 -06003119 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003120 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003121 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003122
Dave Houlton48989f32017-05-26 15:01:46 -06003123 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003124 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 -06003125 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003126 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003127 }
Dave Houlton48989f32017-05-26 15:01:46 -06003128
Dave Houlton33c2d252017-06-09 17:08:32 -06003129 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3130 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 -06003131 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Dave Houlton33c2d252017-06-09 17:08:32 -06003132 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003133 "image format %s.",
3134 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003135 }
3136
3137 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3138 skip |= log_msg(
3139 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003140 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003141 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
3142 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003143 }
3144
Dave Houlton48989f32017-05-26 15:01:46 -06003145 // Validate source image offsets
3146 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003147 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003148 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
3149 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 -06003150 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
Dave Houlton48989f32017-05-26 15:01:46 -06003151 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003152 "of (%1d, %1d). These must be (0, 1).",
3153 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003154 }
3155 }
3156
Dave Houlton33c2d252017-06-09 17:08:32 -06003157 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003158 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3159 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 -06003160 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Dave Houlton48989f32017-05-26 15:01:46 -06003161 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003162 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3163 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003164 }
3165 }
3166
Dave Houlton33c2d252017-06-09 17:08:32 -06003167 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003168 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3169 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003170 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003171 skip |=
3172 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 -06003173 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003174 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3175 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003176 }
3177 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3178 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003179 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003180 skip |= log_msg(
3181 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003182 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003183 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
3184 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003185 }
3186 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3187 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003188 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003189 skip |=
3190 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 -06003191 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003192 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3193 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003194 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003195 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003196 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 -06003197 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003198 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003199 }
Dave Houlton48989f32017-05-26 15:01:46 -06003200
3201 // Validate dest image offsets
3202 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003203 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003204 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
3205 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 -06003206 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
Dave Houlton48989f32017-05-26 15:01:46 -06003207 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003208 "(%1d, %1d). These must be (0, 1).",
3209 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003210 }
3211 }
3212
Dave Houlton33c2d252017-06-09 17:08:32 -06003213 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003214 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3215 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003216 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Dave Houlton48989f32017-05-26 15:01:46 -06003217 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003218 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3219 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003220 }
3221 }
3222
Dave Houlton33c2d252017-06-09 17:08:32 -06003223 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003224 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3225 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003226 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003227 skip |=
3228 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 -06003229 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003230 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
3231 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003232 }
3233 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3234 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003235 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003236 skip |= log_msg(
3237 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003238 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003239 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
3240 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003241 }
3242 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3243 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003244 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003245 skip |=
3246 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 -06003247 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003248 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
3249 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003250 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003251 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003252 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003253 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003254 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003255 }
3256
Dave Houlton33c2d252017-06-09 17:08:32 -06003257 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3258 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3259 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
3260 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 -06003261 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
Dave Houlton33c2d252017-06-09 17:08:32 -06003262 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003263 "layerCount other than 1.",
3264 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003265 }
3266 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003267 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003268 } else {
3269 assert(0);
3270 }
3271 return skip;
3272}
3273
Tobin Ehlis58c884f2017-02-08 12:15:27 -07003274void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003275 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
3276 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
3277 // Make sure that all image slices are updated to correct layout
3278 for (uint32_t i = 0; i < region_count; ++i) {
3279 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
3280 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
3281 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003282 // Update bindings between images and cmd buffer
3283 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3284 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003285}
3286
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003287// 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 -07003288bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003289 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3290 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003291 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07003292 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003293 for (auto cb_image_data : pCB->imageLayoutMap) {
3294 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003295
Dave Houltonb3f4b282018-02-22 16:25:16 -07003296 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3297 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003298 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3299 // TODO: Set memory invalid which is in mem_tracker currently
3300 } else if (imageLayout != cb_image_data.second.initialLayout) {
3301 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003302 skip |= log_msg(
3303 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003304 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003305 "Submitted command buffer expects image 0x%" PRIx64
3306 " (subresource: aspectMask 0x%X array layer %u, mip level %u) to be in layout %s--instead, image 0x%" PRIx64
3307 "'s current layout is %s.",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003308 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
3309 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003310 string_VkImageLayout(cb_image_data.second.initialLayout), HandleToUint64(cb_image_data.first.image),
3311 string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003312 } else {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003313 skip |=
3314 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3315 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3316 "Submitted command buffer expects image 0x%" PRIx64 " to be in layout %s--instead, image 0x%" PRIx64
3317 "'s current layout is %s.",
3318 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(cb_image_data.second.initialLayout),
3319 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003320 }
3321 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003322 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003323 }
3324 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003325 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003326}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003327
Tony Barbourdf013b92017-01-25 12:53:48 -07003328void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
3329 for (auto cb_image_data : pCB->imageLayoutMap) {
3330 VkImageLayout imageLayout;
3331 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3332 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3333 }
3334}
3335
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003336// Print readable FlagBits in FlagMask
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003337static std::string StringVkAccessFlags(VkAccessFlags accessMask) {
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003338 std::string result;
3339 std::string separator;
3340
3341 if (accessMask == 0) {
3342 result = "[None]";
3343 } else {
3344 result = "[";
3345 for (auto i = 0; i < 32; i++) {
3346 if (accessMask & (1 << i)) {
3347 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
3348 separator = " | ";
3349 }
3350 }
3351 result = result + "]";
3352 }
3353 return result;
3354}
3355
Dave Houlton12befb92018-06-26 17:16:46 -06003356#if 0 // This fxn seems vestigial, not called anywhere. All VkAccessFlagBits VUIDs are implicit & being checked by parameter
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003357 // validation ToBeRemoved (disabled 6/18)
Dave Houlton12befb92018-06-26 17:16:46 -06003358
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003359// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
3360// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003361// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003362static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
3363 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
3364 const char *type) {
3365 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3366 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003367
3368 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
3369 if (accessMask & ~(required_bit | optional_bits)) {
3370 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003371 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 -06003372 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003373 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003374 StringVkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003375 }
3376 } else {
3377 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003378 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 -06003379 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003380 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
3381 "has previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003382 type, accessMask, StringVkAccessFlags(accessMask).c_str(), optional_bits,
3383 StringVkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003384 } else {
3385 std::string opt_bits;
3386 if (optional_bits != 0) {
3387 std::stringstream ss;
3388 ss << optional_bits;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003389 opt_bits = "and may have optional bits " + ss.str() + ' ' + StringVkAccessFlags(optional_bits);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003390 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003391 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 -06003392 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003393 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
3394 "previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003395 type, accessMask, StringVkAccessFlags(accessMask).c_str(), required_bit,
3396 StringVkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003397 }
3398 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003399 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003400}
Dave Houlton12befb92018-06-26 17:16:46 -06003401#endif
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003402
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003403// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003404// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3405// layout attachments don't have CLEAR as their loadOp.
Tobias Hectorbbb12282018-10-22 15:17:59 +01003406bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3407 const VkImageLayout first_layout, const uint32_t attachment,
3408 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003409 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003410 const char *vuid;
3411 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3412
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003413 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3414 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003415 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3416 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3417 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003418 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003419 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3420 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3421 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3422 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3423 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3424 skip |=
3425 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3426 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003427 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003428 }
3429 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003430 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3431 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003432 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003433 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003434 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 -06003435 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003436 }
3437 }
3438
3439 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3440 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003441 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003442 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003443 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 -06003444 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003445 }
3446 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003447 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003448}
3449
Tobias Hectorbbb12282018-10-22 15:17:59 +01003450bool ValidateLayouts(const core_validation::layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3451 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003452 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003453 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003454 const char *vuid;
3455 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3456 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003457
Jason Ekstranda1906302017-12-03 20:16:32 -08003458 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3459 VkFormat format = pCreateInfo->pAttachments[i].format;
3460 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3461 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3462 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003463 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 -06003464 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003465 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3466 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3467 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3468 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003469 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003470 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003471 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 -06003472 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003473 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3474 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3475 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3476 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003477 }
3478 }
3479 }
3480
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003481 // Track when we're observing the first use of an attachment
3482 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3483 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003484 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003485
3486 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3487 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3488 auto attach_index = subpass.pInputAttachments[j].attachment;
3489 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003490 switch (subpass.pInputAttachments[j].layout) {
3491 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3492 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3493 // These are ideal.
3494 break;
3495
3496 case VK_IMAGE_LAYOUT_GENERAL:
3497 // May not be optimal. TODO: reconsider this warning based on other constraints.
3498 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003499 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003500 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3501 break;
3502
Tobias Hectorbbb12282018-10-22 15:17:59 +01003503 case VK_IMAGE_LAYOUT_UNDEFINED:
3504 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3505 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3506 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3507 "Layout for input attachment reference %u in subpass %u is %s but must be "
3508 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3509 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3510 break;
3511
Graeme Leese668a9862018-10-08 10:40:02 +01003512 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3513 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3514 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3515 break;
3516 } else {
3517 // Intentionally fall through to generic error message
3518 }
3519 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003520
Cort Stratton7547f772017-05-04 15:18:52 -07003521 default:
3522 // No other layouts are acceptable
3523 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 -06003524 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003525 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3526 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3527 }
3528
Cort Stratton7547f772017-05-04 15:18:52 -07003529 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003530 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3531 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003532
3533 bool used_as_depth =
3534 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3535 bool used_as_color = false;
3536 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3537 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3538 }
3539 if (!used_as_depth && !used_as_color &&
3540 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003541 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3542 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3543 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3544 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003545 }
3546 }
3547 attach_first_use[attach_index] = false;
3548 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003549
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003550 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3551 auto attach_index = subpass.pColorAttachments[j].attachment;
3552 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3553
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003554 // TODO: Need a way to validate shared presentable images here, currently just allowing
3555 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3556 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003557 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003558 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003559 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003560 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3561 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003562 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003563
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003564 case VK_IMAGE_LAYOUT_GENERAL:
3565 // May not be optimal; TODO: reconsider this warning based on other constraints?
3566 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003567 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003568 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3569 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003570
Tobias Hectorbbb12282018-10-22 15:17:59 +01003571 case VK_IMAGE_LAYOUT_UNDEFINED:
3572 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3573 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3574 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3575 "Layout for color attachment reference %u in subpass %u is %s but should be "
3576 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3577 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3578 break;
3579
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003580 default:
3581 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 -06003582 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003583 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3584 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003585 }
3586
Tobias Hectorbbb12282018-10-22 15:17:59 +01003587 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3588 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
3589 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3590 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3591 "Layout for color attachment reference %u in subpass %u is %s but should be "
3592 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3593 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3594 }
3595
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003596 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003597 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3598 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003599 }
3600 attach_first_use[attach_index] = false;
3601 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003602
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003603 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3604 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003605 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3606 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3607 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003608 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003609
Dave Houltona9df0ce2018-02-07 10:51:23 -07003610 case VK_IMAGE_LAYOUT_GENERAL:
3611 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3612 // doing a bunch of transitions.
3613 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003614 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003615 "GENERAL layout for depth attachment may not give optimal performance.");
3616 break;
3617
Tobias Hectorbbb12282018-10-22 15:17:59 +01003618 case VK_IMAGE_LAYOUT_UNDEFINED:
3619 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3620 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3621 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3622 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3623 "layout or GENERAL.",
3624 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3625 break;
3626
Dave Houltona9df0ce2018-02-07 10:51:23 -07003627 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3628 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3629 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3630 break;
3631 } else {
3632 // Intentionally fall through to generic error message
3633 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003634 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003635
Dave Houltona9df0ce2018-02-07 10:51:23 -07003636 default:
3637 // No other layouts are acceptable
3638 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 -06003639 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003640 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3641 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3642 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003643 }
3644
3645 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3646 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003647 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3648 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003649 }
3650 attach_first_use[attach_index] = false;
3651 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003652 }
3653 return skip;
3654}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003655
3656// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003657bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3658 VkDeviceSize offset, VkDeviceSize end_offset) {
3659 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3660 bool skip = false;
3661 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3662 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003663 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3664 for (auto image_handle : mem_info->bound_images) {
3665 auto img_it = mem_info->bound_ranges.find(image_handle);
3666 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003667 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003668 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003669 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003670 for (auto layout : layouts) {
3671 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003672 skip |=
3673 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 -06003674 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003675 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3676 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003677 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003678 }
3679 }
3680 }
3681 }
3682 }
3683 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003684 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003685}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003686
3687// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3688// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003689static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3690 VulkanObjectType obj_type, std::string msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003691 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003692
3693 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003694 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003695 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003696 if (strict) {
3697 correct_usage = ((actual & desired) == desired);
3698 } else {
3699 correct_usage = ((actual & desired) != 0);
3700 }
3701 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003702 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003703 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003704 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003705 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 -06003706 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003707 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3708 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003709 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003710 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003711 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 -06003712 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3713 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003714 }
3715 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003716 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003717}
3718
3719// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3720// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003721bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003722 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003723 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3724 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003725}
3726
Cort Stratton186b1a22018-05-01 20:18:06 -04003727bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Dave Houltone0969282018-05-23 15:54:31 -06003728 char const *func_name, const std::string &linear_vuid, const std::string &optimal_vuid) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003729 VkFormatProperties format_properties = GetPDFormatProperties(dev_data, image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003730 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3731 bool skip = false;
3732 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3733 if ((format_properties.linearTilingFeatures & desired) != desired) {
3734 skip |=
3735 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3736 HandleToUint64(image_state->image), linear_vuid,
3737 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3738 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3739 }
3740 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3741 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3742 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3743 HandleToUint64(image_state->image), optimal_vuid,
3744 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3745 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3746 HandleToUint64(image_state->image));
3747 }
3748 }
3749 return skip;
3750}
3751
Cort Strattond619a302018-05-17 19:46:32 -07003752bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3753 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3754 uint32_t i) {
3755 bool skip = false;
3756 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3757 // layerCount must not be zero
3758 if (subresource_layers->layerCount == 0) {
3759 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3760 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3761 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3762 }
3763 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3764 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3765 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3766 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3767 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3768 }
3769 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3770 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3771 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3772 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3773 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3774 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3775 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3776 func_name, i, member);
3777 }
3778 return skip;
3779}
3780
Mark Lobodzinski96210742017-02-09 10:33:46 -07003781// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3782// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003783bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003784 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003785 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3786 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003787}
3788
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003789bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3790 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3791 bool skip = false;
3792 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3793
3794 const VkDeviceSize &range = pCreateInfo->range;
3795 if (range != VK_WHOLE_SIZE) {
3796 // Range must be greater than 0
3797 if (range <= 0) {
3798 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3799 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3800 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3801 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3802 range);
3803 }
3804 // Range must be a multiple of the element size of format
3805 const size_t format_size = FormatSize(pCreateInfo->format);
3806 if (range % format_size != 0) {
3807 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3808 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3809 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3810 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3811 "(" PRINTF_SIZE_T_SPECIFIER ").",
3812 range, format_size);
3813 }
3814 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3815 if (range / format_size > device_limits->maxTexelBufferElements) {
3816 skip |=
3817 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3818 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3819 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3820 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3821 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3822 range, format_size, device_limits->maxTexelBufferElements);
3823 }
3824 // The sum of range and offset must be less than or equal to the size of buffer
3825 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
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-offset-00931",
3828 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3829 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3830 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3831 range, pCreateInfo->offset, buffer_state->createInfo.size);
3832 }
3833 }
3834 return skip;
3835}
3836
Shannon McPherson265383a2018-06-21 15:37:52 -06003837bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3838 const VkBufferViewCreateInfo *pCreateInfo) {
3839 bool skip = false;
3840 const debug_report_data *report_data = GetReportData(device_data);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003841 const VkFormatProperties format_properties = GetPDFormatProperties(device_data, pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003842 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3843 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3844 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3845 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3846 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3847 "be supported for uniform texel buffers");
3848 }
3849 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3850 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3851 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3852 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3853 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3854 "be supported for storage texel buffers");
3855 }
3856 return skip;
3857}
3858
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003859bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003860 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003861 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3862
Dave Houltond8ed0212018-05-16 17:18:24 -06003863 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003864
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003865 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003866 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 -06003867 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003868 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003869 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003870 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003871
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003872 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3873 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003874 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 -06003875 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003876 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003877 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003878 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003879
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003880 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3881 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003882 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 -06003883 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003884 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003885 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003886 }
Jeff Bolz87697532019-01-11 22:54:00 -06003887
3888 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3889 if (chained_devaddr_struct) {
3890 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3891 chained_devaddr_struct->deviceAddress != 0) {
3892 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3893 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3894 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3895 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3896 }
3897 }
3898
3899 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3900 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddressCaptureReplay) {
3901 skip |= log_msg(
3902 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3903 "VUID-VkBufferCreateInfo-flags-02605",
3904 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3905 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3906 }
3907
3908 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
3909 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddress) {
3910 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3911 "VUID-VkBufferCreateInfo-usage-02606",
3912 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3913 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3914 }
3915
Mark Lobodzinski96210742017-02-09 10:33:46 -07003916 return skip;
3917}
3918
3919void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3920 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3921 GetBufferMap(device_data)
3922 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3923}
3924
Shannon McPhersona84241a2018-06-18 15:34:46 -06003925bool PreCallValidateCreateBufferView(const layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003926 bool skip = false;
Shannon McPherson883f6092018-06-14 13:15:25 -06003927 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003928 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003929 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3930 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003931 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3932 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003933 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3934 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003935 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3936 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3937 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3938 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003939
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003940 // Buffer view offset must be less than the size of buffer
3941 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3942 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3943 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3944 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3945 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3946 pCreateInfo->offset, buffer_state->createInfo.size);
3947 }
3948
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07003949 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06003950 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3951 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3952 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3953 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3954 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3955 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3956 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3957 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003958
3959 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003960
3961 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003962 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003963 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003964}
3965
3966void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3967 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3968}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003969
3970// For the given format verify that the aspect masks make sense
Tobias Hectorbbb12282018-10-22 15:17:59 +01003971bool ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3972 const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003973 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3974 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003975 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3976 if (image != VK_NULL_HANDLE) {
3977 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3978 }
3979
Dave Houlton1d2022c2017-03-29 11:43:58 -06003980 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003981 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003982 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003983 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003984 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003985 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003986 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003987 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003988 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003989 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003990 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003991 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003992 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3993 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003994 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003995 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003996 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003997 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3998 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003999 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004000 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004001 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004002 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004003 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004004 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004005 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004006 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004007 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004008 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004009 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004010 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004011 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004012 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004013 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004014 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004015 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004016 } else if (FormatIsMultiplane(format)) {
4017 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4018 if (3 == FormatPlaneCount(format)) {
4019 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4020 }
4021 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004022 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004023 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4024 "set, where n = [0, 1, 2].",
4025 func_name);
4026 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004027 }
4028 return skip;
4029}
4030
Petr Krausffa94af2017-08-08 21:46:02 +02004031struct SubresourceRangeErrorCodes {
Dave Houltond8ed0212018-05-16 17:18:24 -06004032 std::string base_mip_err, mip_count_err, base_layer_err, layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02004033};
4034
4035bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
4036 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
4037 const char *image_layer_count_var_name, const uint64_t image_handle,
4038 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004039 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4040 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004041
4042 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004043 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004044 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 -06004045 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004046 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004047 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4048 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004049 }
Petr Kraus4d718682017-05-18 03:38:41 +02004050
Petr Krausffa94af2017-08-08 21:46:02 +02004051 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4052 if (subresourceRange.levelCount == 0) {
4053 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 -06004054 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004055 } else {
4056 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004057
Petr Krausffa94af2017-08-08 21:46:02 +02004058 if (necessary_mip_count > image_mip_count) {
4059 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 -06004060 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004061 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004062 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004063 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004064 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004065 }
Petr Kraus4d718682017-05-18 03:38:41 +02004066 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004067 }
Petr Kraus4d718682017-05-18 03:38:41 +02004068
4069 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004070 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004071 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 -06004072 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004073 "%s: %s.baseArrayLayer (= %" PRIu32
4074 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4075 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004076 }
Petr Kraus4d718682017-05-18 03:38:41 +02004077
Petr Krausffa94af2017-08-08 21:46:02 +02004078 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4079 if (subresourceRange.layerCount == 0) {
4080 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 -06004081 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004082 } else {
4083 const uint64_t necessary_layer_count =
4084 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004085
Petr Krausffa94af2017-08-08 21:46:02 +02004086 if (necessary_layer_count > image_layer_count) {
4087 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 -06004088 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004089 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004090 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004091 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004092 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004093 }
Petr Kraus4d718682017-05-18 03:38:41 +02004094 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004095 }
Petr Kraus4d718682017-05-18 03:38:41 +02004096
Mark Lobodzinski602de982017-02-09 11:01:33 -07004097 return skip;
4098}
4099
Petr Krausffa94af2017-08-08 21:46:02 +02004100bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4101 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
4102 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
4103 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4104 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4105 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4106
4107 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4108 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4109
4110 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004111 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4112 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4113 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4114 : "VUID-VkImageViewCreateInfo-image-01482")
4115 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4116 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4117 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4118 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4119 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004120
4121 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4122 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4123 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4124}
4125
4126bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4127 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4128 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004129 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4130 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4131 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4132 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004133
4134 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4135 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4136 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4137}
4138
4139bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4140 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4141 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004142 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4143 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4144 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4145 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004146
4147 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4148 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4149 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4150}
4151
4152bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4153 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4154 const char *param_name) {
4155 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004156 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4157 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4158 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4159 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004160
4161 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4162 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4163 subresourceRangeErrorCodes);
4164}
4165
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004166bool PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4167 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
4168 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4169 const debug_report_data *report_data = device_data->report_data;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004170 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004171 IMAGE_STATE *image_state = GetImageState(device_data, pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004172 if (image_state) {
4173 skip |= ValidateImageUsageFlags(
4174 device_data, image_state,
4175 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004176 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4177 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004178 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004179 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004180 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004181 skip |=
4182 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004183 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004184 skip |= ValidateCreateImageViewSubresourceRange(
4185 device_data, image_state,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004186 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4187 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004188
4189 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4190 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004191 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4192 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004193 VkFormat view_format = pCreateInfo->format;
4194 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004195 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004196 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004197
Dave Houltonbd2e2622018-04-10 16:41:14 -06004198 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004199 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004200 if (chained_ivuci_struct) {
4201 if (chained_ivuci_struct->usage & ~image_usage) {
4202 std::stringstream ss;
4203 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004204 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004205 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004206 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 -07004207 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004208 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004209 }
4210
4211 image_usage = chained_ivuci_struct->usage;
4212 }
4213
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004214 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4215 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004216 if (FormatIsMultiplane(image_format)) {
4217 // View format must match the multiplane compatible format
4218 uint32_t plane = 3; // invalid
4219 switch (aspect_mask) {
4220 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4221 plane = 0;
4222 break;
4223 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4224 plane = 1;
4225 break;
4226 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4227 plane = 2;
4228 break;
4229 default:
4230 break;
4231 }
4232
4233 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4234 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004235 std::stringstream ss;
4236 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004237 << " is not compatible with plane " << plane << " of underlying image format "
4238 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004239 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 -07004240 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004241 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004242 }
4243 } else {
4244 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
4245 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4246 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4247 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4248 std::stringstream ss;
4249 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004250 << " is not in the same format compatibility class as image (" << HandleToUint64(pCreateInfo->image)
Dave Houltonc7988072018-04-16 11:46:56 -06004251 << ") format " << string_VkFormat(image_format)
4252 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4253 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004254 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 -07004255 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004256 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004257 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004258 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004259 }
4260 } else {
4261 // Format MUST be IDENTICAL to the format the image was created with
4262 if (image_format != view_format) {
4263 std::stringstream ss;
4264 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004265 << HandleToUint64(pCreateInfo->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004266 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004267 skip |=
4268 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004269 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004270 }
4271 }
4272
4273 // Validate correct image aspect bits for desired formats and format consistency
4274 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004275
4276 switch (image_type) {
4277 case VK_IMAGE_TYPE_1D:
4278 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004279 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 -07004280 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004281 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4282 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004283 }
4284 break;
4285 case VK_IMAGE_TYPE_2D:
4286 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4287 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4288 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004289 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 -07004290 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004291 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4292 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004293 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004294 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004295 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004296 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4297 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004298 }
4299 }
4300 break;
4301 case VK_IMAGE_TYPE_3D:
4302 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4303 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4304 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4305 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004306 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004307 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004308 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004309 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4310 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004311 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4312 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004313 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004314 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004315 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004316 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4317 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004318 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4319 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004320 }
4321 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004322 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004323 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004324 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4325 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004326 }
4327 }
4328 } else {
4329 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004330 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004331 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004332 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4333 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004334 }
4335 }
4336 break;
4337 default:
4338 break;
4339 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004340
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004341 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
4342 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004343 skip |= ValidateCreateImageViewANDROID(device_data, pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004344 }
4345
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004346 VkFormatProperties format_properties = GetPDFormatProperties(device_data, view_format);
4347 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4348 : format_properties.optimalTilingFeatures;
4349
4350 if (tiling_features == 0) {
4351 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 -07004352 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004353 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4354 "physical device.",
4355 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4356 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4357 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 -07004358 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004359 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4360 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4361 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4362 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4363 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 -07004364 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004365 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4366 "VK_IMAGE_USAGE_STORAGE_BIT.",
4367 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4368 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4369 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4370 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 -07004371 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004372 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4373 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4374 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4375 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4376 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4377 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-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004379 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4380 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4381 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004382 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004383
Jeff Bolz9af91c52018-09-01 21:53:57 -05004384 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4385 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4386 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 -07004387 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004388 "vkCreateImageView() If image was created with usage containing "
4389 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4390 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4391 }
4392 if (view_format != VK_FORMAT_R8_UINT) {
4393 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 -07004394 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004395 "vkCreateImageView() If image was created with usage containing "
4396 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4397 }
4398 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004399 }
4400 return skip;
4401}
4402
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004403void PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4404 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
4405 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004406 auto image_view_map = GetImageViewMap(device_data);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004407 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004408
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004409 auto image_state = GetImageState(device_data, pCreateInfo->image);
4410 auto &sub_res_range = (*image_view_map)[*pView].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004411 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4412 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004413}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004414
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004415bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4416 BUFFER_STATE *dst_buffer_state) {
4417 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004418 skip |=
4419 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4420 skip |=
4421 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004422 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004423 skip |=
4424 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4425 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4426 skip |=
4427 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4428 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004429 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004430 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4431 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004432 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004433 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004434 return skip;
4435}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004436
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004437void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4438 BUFFER_STATE *dst_buffer_state) {
4439 // Update bindings between buffers and cmd buffer
4440 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4441 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004442}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004443
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004444static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004445 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4446 bool skip = false;
4447 auto buffer_state = GetBufferState(device_data, buffer);
4448 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004449 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 -06004450 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01004451 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004452 } else {
4453 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004454 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 -06004455 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004456 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004457 }
4458 }
4459 return skip;
4460}
4461
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004462bool PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
4463 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4464 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(device_data, imageView);
4465 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4466
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004467 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004468 if (image_view_state) {
4469 skip |= ValidateObjectNotInUse(device_data, image_view_state, obj_struct, "vkDestroyImageView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004470 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004471 }
4472 return skip;
4473}
4474
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004475void PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
4476 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4477 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(device_data, imageView);
4478 if (!image_view_state) return;
4479 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4480
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004481 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004482 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004483 (*GetImageViewMap(device_data)).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004484}
4485
4486bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
4487 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02004488 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004489 if (GetDisables(device_data)->destroy_buffer) return false;
4490 bool skip = false;
4491 if (*buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004492 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004493 }
4494 return skip;
4495}
4496
John Zulauffca05c12018-04-26 16:30:39 -06004497void PreCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004498 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004499 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4500 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4501 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004502 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004503 }
4504 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004505 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004506 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004507 GetBufferMap(device_data)->erase(buffer_state->buffer);
4508}
4509
4510bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
4511 VK_OBJECT *obj_struct) {
4512 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004513 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004514 if (GetDisables(device_data)->destroy_buffer_view) return false;
4515 bool skip = false;
4516 if (*buffer_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004517 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView",
4518 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004519 }
4520 return skip;
4521}
4522
John Zulauffca05c12018-04-26 16:30:39 -06004523void PreCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
4524 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004525 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004526 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004527 GetBufferViewMap(device_data)->erase(buffer_view);
4528}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004529
4530bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
4531 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004532 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004533 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004534 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4535 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004536 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4537 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004538 skip |=
4539 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4540 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004541 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004542 return skip;
4543}
4544
4545void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004546 // Update bindings between buffer and cmd buffer
4547 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004548}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004549
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004550bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4551 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004552 bool skip = false;
4553
4554 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004555 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4556 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004557 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 -06004558 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004559 "%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 -06004560 "and 1, respectively.",
4561 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004562 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004563 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004564
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004565 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4566 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004567 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 -06004568 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004569 "%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 -06004570 "must be 0 and 1, respectively.",
4571 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004572 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004573 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004574
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004575 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4576 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004577 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004578 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004579 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4580 "For 3D images these must be 0 and 1, respectively.",
4581 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004582 }
4583 }
4584
4585 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
4586 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06004587 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06004588 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004589 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 -06004590 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004591 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004592 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
4593 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004594 }
4595
4596 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004597 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004598 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 -06004599 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004600 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4601 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004602 }
4603
4604 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4605 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004606 skip |=
4607 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004608 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004609 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4610 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004611 }
4612
4613 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4614 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4615 skip |= log_msg(
4616 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004617 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004618 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4619 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004620 }
4621
4622 // subresource aspectMask must have exactly 1 bit set
4623 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4624 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4625 if (aspect_mask_bits.count() != 1) {
4626 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 -06004627 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004628 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004629 }
4630
4631 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004632 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004633 skip |= log_msg(
4634 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004635 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004636 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4637 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004638 }
4639
4640 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004641 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004642 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004643
4644 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004645 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004646 skip |= log_msg(
4647 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004648 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004649 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4650 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004651 }
4652
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004653 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004654 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004655 skip |= log_msg(
4656 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004657 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004658 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4659 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004660 }
4661
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004662 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004663 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4664 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4665 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004666 skip |=
4667 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004668 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004669 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4670 "width & height (%d, %d)..",
4671 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004672 }
4673
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004674 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004675 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
4676 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004677 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 -06004678 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004679 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4680 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
4681 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004682 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004683
4684 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004685 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004686 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004687 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4688 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 -06004689 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004690 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004691 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004692 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004693 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004694 }
4695
4696 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004697 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004698 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4699 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 -06004700 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004701 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004702 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004703 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004704 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004705 }
4706
4707 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004708 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004709 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4710 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 -06004711 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004712 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004713 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004714 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004715 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004716 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004717 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004718 }
4719
4720 return skip;
4721}
4722
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004723static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Dave Houltond8ed0212018-05-16 17:18:24 -06004724 const VkBufferImageCopy *pRegions, const char *func_name, std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004725 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004726 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004727
4728 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004729 VkExtent3D extent = pRegions[i].imageExtent;
4730 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004731
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004732 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4733 {
Dave Houlton51653902018-06-22 17:32:13 -06004734 skip |=
4735 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4736 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4737 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004738 }
4739
4740 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4741
4742 // 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 -06004743 if (FormatIsCompressed(image_info->format)) {
4744 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004745 if (image_extent.width % block_extent.width) {
4746 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4747 }
4748 if (image_extent.height % block_extent.height) {
4749 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4750 }
4751 if (image_extent.depth % block_extent.depth) {
4752 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4753 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004754 }
4755
Dave Houltonfc1a4052017-04-27 14:32:45 -06004756 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004757 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 -06004758 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004759 }
4760 }
4761
4762 return skip;
4763}
4764
Chris Forbese8ba09a2017-06-01 17:39:02 -07004765static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004766 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06004767 std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004768 bool skip = false;
4769
4770 VkDeviceSize buffer_size = buff_state->createInfo.size;
4771
4772 for (uint32_t i = 0; i < regionCount; i++) {
4773 VkExtent3D copy_extent = pRegions[i].imageExtent;
4774
4775 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4776 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004777 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004778
Dave Houltonf3229d52017-02-21 15:59:08 -07004779 // Handle special buffer packing rules for specific depth/stencil formats
4780 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004781 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004782 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4783 switch (image_state->createInfo.format) {
4784 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004785 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004786 break;
4787 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004788 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004789 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004790 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004791 case VK_FORMAT_D24_UNORM_S8_UINT:
4792 unit_size = 4;
4793 break;
4794 default:
4795 break;
4796 }
4797 }
4798
Tom Cooperb2550c72018-10-15 13:08:41 +01004799 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004800 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06004801 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004802 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4803 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4804
4805 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4806 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4807 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004808 }
4809
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004810 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4811 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4812 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004813 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004814 } else {
4815 // Calculate buffer offset of final copied byte, + 1.
4816 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4817 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4818 max_buffer_offset *= unit_size; // convert to bytes
4819 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004820
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004821 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004822 skip |=
4823 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4824 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004825 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004826 }
4827 }
4828
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004829 return skip;
4830}
4831
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004832bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004833 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004834 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004835 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4836 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4837
4838 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004839 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004840
4841 // Command pool must support graphics, compute, or transfer operations
4842 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4843
4844 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4845 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4846 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 -06004847 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004848 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004849 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004850 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004851 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004852 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004853 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004854 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004855
4856 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004857 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4858 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4859 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4860 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4861 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004862
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004863 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004864 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4865 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4866 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004867 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004868 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4869 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004870 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4871 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004872 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4873 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004874 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004875 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004876 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004877 const std::string src_invalid_layout_vuid =
4878 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4879 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4880 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004881 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004882 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4883 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004884 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004885 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4886 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004887 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004888 "vkCmdCopyImageToBuffer()",
4889 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004890 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4891 "vkCmdCopyImageToBuffer()", "imageSubresource",
4892 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4893 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4894 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4895 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004896 }
4897 return skip;
4898}
4899
4900void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004901 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4902 VkImageLayout src_image_layout) {
4903 // Make sure that all image slices are updated to correct layout
4904 for (uint32_t i = 0; i < region_count; ++i) {
4905 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4906 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004907 // Update bindings between buffer/image and cmd buffer
4908 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004909 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004910}
4911
4912bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004913 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004914 const VkBufferImageCopy *pRegions, const char *func_name) {
4915 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4916 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4917
4918 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004919 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004920
4921 // Command pool must support graphics, compute, or transfer operations
4922 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4923 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4924 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4925 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 -06004926 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004927 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004928 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004929 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004930 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004931 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004932 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004933 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004934 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004935 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4936 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4937 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4938 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4939 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004940 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004941 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4942 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4943 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4944 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4945 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004946 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4947 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004948 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4949 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004950 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004951 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004952 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004953 const std::string dst_invalid_layout_vuid =
4954 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4955 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4956 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004957 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004958 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4959 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004960 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004961 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4962 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004963 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004964 "vkCmdCopyBufferToImage()",
4965 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004966 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4967 "vkCmdCopyBufferToImage()", "imageSubresource",
4968 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4969 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4970 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4971 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004972 }
4973 return skip;
4974}
4975
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004976void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004977 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4978 VkImageLayout dst_image_layout) {
4979 // Make sure that all image slices are updated to correct layout
4980 for (uint32_t i = 0; i < region_count; ++i) {
4981 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4982 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004983 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004984 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004985}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004986
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07004987bool PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
4988 VkSubresourceLayout *pLayout) {
4989 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4990 const auto report_data = device_data->report_data;
Mike Weiblen672b58b2017-02-21 14:32:53 -07004991 bool skip = false;
4992 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4993
Dave Houlton1d960ff2018-01-19 12:17:05 -07004994 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004995 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4996 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4997 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004998 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 -06004999 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005000 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005001 }
5002
5003 IMAGE_STATE *image_entry = GetImageState(device_data, image);
5004 if (!image_entry) {
5005 return skip;
5006 }
5007
Dave Houlton1d960ff2018-01-19 12:17:05 -07005008 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005009 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005010 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5011 "VUID-vkGetImageSubresourceLayout-image-00996",
5012 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005013 }
5014
Dave Houlton1d960ff2018-01-19 12:17:05 -07005015 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005016 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005017 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5018 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5019 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5020 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005021 }
5022
Dave Houlton1d960ff2018-01-19 12:17:05 -07005023 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005024 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005025 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5026 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5027 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5028 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005029 }
5030
Dave Houlton1d960ff2018-01-19 12:17:05 -07005031 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005032 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005033 if (FormatIsMultiplane(img_format)) {
5034 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Dave Houltond8ed0212018-05-16 17:18:24 -06005035 std::string vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005036 if (FormatPlaneCount(img_format) > 2u) {
5037 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005038 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005039 }
5040 if (sub_aspect != (sub_aspect & allowed_flags)) {
5041 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 -06005042 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005043 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005044 ") must be a single-plane specifier flag.",
5045 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005046 }
5047 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005048 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005049 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005050 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005051 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005052 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005053 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005054 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005055 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005056 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 -06005057 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005058 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005059 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005060 }
5061 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005062
5063 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
5064 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
5065 }
5066
Mike Weiblen672b58b2017-02-21 14:32:53 -07005067 return skip;
5068}