blob: 3c9f83e13808d2bc92ad01fcd810ad5dd0d2654b [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
Dave Houltond9611312018-11-19 17:03:36 -070039uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
40 // uint cast applies floor()
41 return 1u + (uint32_t)log2(std::max({height, width, depth}));
42}
43
44uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
45
46uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
47
Tobin Ehlis58c884f2017-02-08 12:15:27 -070048void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070049 auto it = pCB->imageLayoutMap.find(imgpair);
50 if (it != pCB->imageLayoutMap.end()) {
51 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070052 } else {
53 assert(imgpair.hasSubresource);
54 IMAGE_CMD_BUF_LAYOUT_NODE node;
55 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
56 node.initialLayout = layout;
57 }
58 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
59 }
60}
61template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070062void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070063 ImageSubresourcePair imgpair = {image, true, range};
64 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
65 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
66 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
67 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -070068 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
69 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
70 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
71 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
72 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070073}
74
75template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070076void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070077 VkImageAspectFlags aspectMask) {
78 if (imgpair.subresource.aspectMask & aspectMask) {
79 imgpair.subresource.aspectMask = aspectMask;
80 SetLayout(device_data, pObject, imgpair, layout);
81 }
82}
83
Tony Barbourdf013b92017-01-25 12:53:48 -070084// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070085void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
86 VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070087 auto it = imageLayoutMap.find(imgpair);
88 if (it != imageLayoutMap.end()) {
89 it->second.layout = layout; // Update
90 } else {
91 imageLayoutMap[imgpair].layout = layout; // Insert
92 }
Tony Barbourdf013b92017-01-25 12:53:48 -070093}
94
Tobin Ehlisc8266452017-04-07 12:20:30 -060095bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070096 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
97 const debug_report_data *report_data = core_validation::GetReportData(device_data);
98
99 if (!(imgpair.subresource.aspectMask & aspectMask)) {
100 return false;
101 }
102 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
103 imgpair.subresource.aspectMask = aspectMask;
104 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
105 if (imgsubIt == pCB->imageLayoutMap.end()) {
106 return false;
107 }
108 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200109 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 -0600110 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700111 "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 +0200112 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700113 string_VkImageLayout(imgsubIt->second.layout));
114 }
115 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200116 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 -0600117 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700118 "Cannot query for VkImage 0x%" PRIx64
119 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200120 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700121 string_VkImageLayout(imgsubIt->second.initialLayout));
122 }
123 node = imgsubIt->second;
124 return true;
125}
126
Tobin Ehlisc8266452017-04-07 12:20:30 -0600127bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700128 const VkImageAspectFlags aspectMask) {
129 if (!(imgpair.subresource.aspectMask & aspectMask)) {
130 return false;
131 }
132 const debug_report_data *report_data = core_validation::GetReportData(device_data);
133 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
134 imgpair.subresource.aspectMask = aspectMask;
135 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
136 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
137 return false;
138 }
139 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200140 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 -0600141 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700142 "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 +0200143 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700144 string_VkImageLayout(imgsubIt->second.layout));
145 }
146 layout = imgsubIt->second.layout;
147 return true;
148}
149
150// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600151bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700152 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
153 ImageSubresourcePair imgpair = {image, true, range};
154 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
155 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
156 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
157 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
158 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700159 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
160 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
161 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
162 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
163 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700164 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
165 imgpair = {image, false, VkImageSubresource()};
166 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
167 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
168 // TODO: This is ostensibly a find function but it changes state here
169 node = imgsubIt->second;
170 }
171 return true;
172}
173
174// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700175bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700176 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
177 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
178 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
179 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
180 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700181 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
182 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
183 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
184 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
185 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700186 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
187 imgpair = {imgpair.image, false, VkImageSubresource()};
188 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
189 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
190 layout = imgsubIt->second.layout;
191 }
192 return true;
193}
194
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700195bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700196 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
197 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700198 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700199 if (!image_state) return false;
200 bool ignoreGlobal = false;
201 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
202 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
203 ignoreGlobal = true;
204 }
205 for (auto imgsubpair : sub_data->second) {
206 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
207 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
208 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
209 layouts.push_back(img_data->second.layout);
210 }
211 }
212 return true;
213}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700214bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
215 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700216 if (!(imgpair.subresource.aspectMask & aspectMask)) {
217 return false;
218 }
219 imgpair.subresource.aspectMask = aspectMask;
220 auto imgsubIt = imageLayoutMap.find(imgpair);
221 if (imgsubIt == imageLayoutMap.end()) {
222 return false;
223 }
224 layout = imgsubIt->second.layout;
225 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700226}
Tony Barbourdf013b92017-01-25 12:53:48 -0700227
228// find layout in supplied map
Dave Houltonb3f4b282018-02-22 16:25:16 -0700229bool FindLayout(layer_data *device_data, const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
230 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700231 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
232 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
233 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
234 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
235 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700236 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
237 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
238 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
239 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
240 }
241 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700242 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
243 imgpair = {imgpair.image, false, VkImageSubresource()};
244 auto imgsubIt = imageLayoutMap.find(imgpair);
245 if (imgsubIt == imageLayoutMap.end()) return false;
246 layout = imgsubIt->second.layout;
247 }
248 return true;
249}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700250
251// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700252void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700253 VkImage &image = imgpair.image;
Dave Houltonb3f4b282018-02-22 16:25:16 -0700254 auto &lmap = (*core_validation::GetImageLayoutMap(device_data));
255 auto data = lmap.find(imgpair);
256 if (data != lmap.end()) {
257 data->second.layout = layout; // Update
258 } else {
259 lmap[imgpair].layout = layout; // Insert
260 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700261 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
262 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
263 if (subresource == image_subresources.end()) {
264 image_subresources.push_back(imgpair);
265 }
266}
267
268// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700269void 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 -0700270 auto it = pCB->imageLayoutMap.find(imgpair);
271 if (it != pCB->imageLayoutMap.end()) {
272 it->second = node; // Update
273 } else {
274 pCB->imageLayoutMap[imgpair] = node; // Insert
275 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700276}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600277// Set image layout for given VkImageSubresourceRange struct
278void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
279 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
280 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700281 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600282 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
283 uint32_t level = image_subresource_range.baseMipLevel + level_index;
284 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
285 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
286 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700287 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
288 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600289 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600290 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700291 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
292 }
293 }
Tony-LunarG119b38a2018-12-18 09:49:16 -0700294 // For multiplane images, IMAGE_ASPECT_COLOR is an alias for all of the plane bits
295 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
296 if (FormatIsMultiplane(image_state->createInfo.format)) {
297 if (sub.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
298 sub.aspectMask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
299 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR;
300 if (FormatPlaneCount(image_state->createInfo.format) > 2) {
301 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
302 }
303 }
304 }
305 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600306 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700307 }
308 }
309}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600310// Set image layout for given VkImageSubresourceLayers struct
311void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
312 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
313 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
314 VkImageSubresourceRange image_subresource_range;
315 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
316 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
317 image_subresource_range.layerCount = image_subresource_layers.layerCount;
318 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
319 image_subresource_range.levelCount = 1;
320 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
321}
Dave Houltonddd65c52018-05-08 14:58:01 -0600322
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600323// Set image layout for all slices of an image view
John Zulauf4ccf5c02018-09-21 11:46:18 -0600324void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_VIEW_STATE *view_state,
325 const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600326 assert(view_state);
327
Dave Houltonddd65c52018-05-08 14:58:01 -0600328 IMAGE_STATE *image_state = GetImageState(device_data, view_state->create_info.image);
329 VkImageSubresourceRange sub_range = view_state->create_info.subresourceRange;
330
331 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
332 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
333 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state->create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
334 sub_range.baseArrayLayer = 0;
335 sub_range.layerCount = image_state->createInfo.extent.depth;
336 }
337
338 SetImageLayout(device_data, cb_node, image_state, sub_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600339}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700340
John Zulauf4ccf5c02018-09-21 11:46:18 -0600341void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
342 auto view_state = GetImageViewState(device_data, imageView);
343 SetImageViewLayout(device_data, cb_node, view_state, layout);
344}
345
Tobias Hectorbbb12282018-10-22 15:17:59 +0100346bool ValidateRenderPassLayoutAgainstFramebufferImageUsage(layer_data *device_data, RenderPassCreateVersion rp_version,
347 VkImageLayout layout, VkImage image, VkImageView image_view,
348 VkFramebuffer framebuffer, VkRenderPass renderpass,
349 uint32_t attachment_index, const char *variable_name) {
350 bool skip = false;
351 const auto report_data = core_validation::GetReportData(device_data);
352 auto image_state = GetImageState(device_data, image);
353 const char *vuid;
354 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
355
356 if (!image_state) {
357 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
358 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
359 "Render Pass begin with renderpass 0x%" PRIx64 " uses framebuffer 0x%" PRIx64 " where pAttachments[%" PRIu32
360 "] = image view 0x%" PRIx64 ", which refers to an invalid image",
361 HandleToUint64(renderpass), HandleToUint64(framebuffer), attachment_index, HandleToUint64(image_view));
362 return skip;
363 }
364
365 auto image_usage = image_state->createInfo.usage;
366
367 // Check for layouts that mismatch image usages in the framebuffer
368 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
369 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
370 skip |=
371 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
372 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
373 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
374 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
375 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
376 HandleToUint64(renderpass), HandleToUint64(image_view));
377 }
378
379 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
380 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
381 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
382 skip |=
383 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
384 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
385 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
386 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
387 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
388 HandleToUint64(renderpass), HandleToUint64(image_view));
389 }
390
391 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
392 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
393 skip |=
394 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
395 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
396 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
397 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
398 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
399 HandleToUint64(renderpass), HandleToUint64(image_view));
400 }
401
402 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
403 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
404 skip |=
405 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
406 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
407 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
408 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
409 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
410 HandleToUint64(renderpass), HandleToUint64(image_view));
411 }
412
413 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
414 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
415 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
416 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
417 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
418 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
419 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
420 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
421 HandleToUint64(image), vuid,
422 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
423 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
424 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
425 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
426 HandleToUint64(renderpass), HandleToUint64(image_view));
427 }
428 } else {
429 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
430 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
431 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
432 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
433 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
434 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
435 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
436 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
437 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
438 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
439 HandleToUint64(renderpass), HandleToUint64(image_view));
440 }
441 }
442 return skip;
443}
444
445bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700446 const VkRenderPassBeginInfo *pRenderPassBegin,
447 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600448 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700449 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700450 auto const &framebufferInfo = framebuffer_state->createInfo;
451 const auto report_data = core_validation::GetReportData(device_data);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100452
453 auto render_pass = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->renderPass;
454 auto framebuffer = framebuffer_state->framebuffer;
455
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700456 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600457 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 -0600458 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700459 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700460 }
461 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
462 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700463 auto view_state = GetImageViewState(device_data, image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600464
465 if (!view_state) {
466 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
467 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
468 "vkCmdBeginRenderPass() :framebuffer 0x%" PRIx64 " pAttachments[%" PRIu32 "] = 0x%" PRIx64
469 " is not a valid VkImageView handle",
470 HandleToUint64(framebuffer_state->framebuffer), i, HandleToUint64(image_view));
471 continue;
472 }
473
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700474 const VkImage &image = view_state->create_info.image;
475 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700476 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100477 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
478
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700479 // TODO: Do not iterate over every possibility - consolidate where possible
480 for (uint32_t j = 0; j < subRange.levelCount; j++) {
481 uint32_t level = subRange.baseMipLevel + j;
482 for (uint32_t k = 0; k < subRange.layerCount; k++) {
483 uint32_t layer = subRange.baseArrayLayer + k;
484 VkImageSubresource sub = {subRange.aspectMask, level, layer};
485 IMAGE_CMD_BUF_LAYOUT_NODE node;
486 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700487 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700488 continue;
489 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700490 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600491 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 -0600492 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700493 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
494 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
495 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600496 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700497 }
498 }
499 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100500
501 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, initial_layout, image, image_view,
502 framebuffer, render_pass, i, "initial layout");
503
504 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, final_layout, image, image_view, framebuffer,
505 render_pass, i, "final layout");
506 }
507
508 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
509 auto &subpass = pRenderPassInfo->pSubpasses[j];
510 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
511 auto &attachment_ref = subpass.pInputAttachments[k];
512 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
513 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
514 auto view_state = GetImageViewState(device_data, image_view);
515
516 if (view_state) {
517 auto image = view_state->create_info.image;
518 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
519 image_view, framebuffer, render_pass,
520 attachment_ref.attachment, "input attachment layout");
521 }
522 }
523 }
524
525 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
526 auto &attachment_ref = subpass.pColorAttachments[k];
527 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
528 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
529 auto view_state = GetImageViewState(device_data, image_view);
530
531 if (view_state) {
532 auto image = view_state->create_info.image;
533 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
534 image_view, framebuffer, render_pass,
535 attachment_ref.attachment, "color attachment layout");
536 if (subpass.pResolveAttachments) {
537 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
538 device_data, rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
539 attachment_ref.attachment, "resolve attachment layout");
540 }
541 }
542 }
543 }
544
545 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
546 auto &attachment_ref = *subpass.pDepthStencilAttachment;
547 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
548 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
549 auto view_state = GetImageViewState(device_data, image_view);
550
551 if (view_state) {
552 auto image = view_state->create_info.image;
553 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
554 image_view, framebuffer, render_pass,
555 attachment_ref.attachment, "input attachment layout");
556 }
557 }
558 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700559 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600560 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700561}
562
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700563void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Tobias Hectorbbb12282018-10-22 15:17:59 +0100564 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700565 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf8e308292018-09-21 11:34:37 -0600566 auto image_view = GetAttachmentImageViewState(device_data, pFramebuffer, ref.attachment);
567 if (image_view) {
568 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
569 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700570 }
571}
572
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700573void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700574 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700575 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700576
577 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700578 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700579 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
580 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
581 }
582 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
583 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
584 }
585 if (subpass.pDepthStencilAttachment) {
586 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
587 }
588 }
589}
590
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600591bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700592 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700593 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
594 return false;
595 }
596 VkImageSubresource sub = {aspect, level, layer};
597 IMAGE_CMD_BUF_LAYOUT_NODE node;
598 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700599 return false;
600 }
601 bool skip = false;
602 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
603 // TODO: Set memory invalid which is in mem_tracker currently
604 } else if (node.layout != mem_barrier->oldLayout) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600605 skip = log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
606 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
607 "VUID-VkImageMemoryBarrier-oldLayout-01197",
608 "For image 0x%" PRIx64
609 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
610 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
611 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700612 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700613 return skip;
614}
615
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700616// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
617// 1. Transition into initialLayout state
618// 2. Transition from initialLayout to layout used in subpass 0
619void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
620 FRAMEBUFFER_STATE *framebuffer_state) {
621 // First transition into initialLayout
622 auto const rpci = render_pass_state->createInfo.ptr();
623 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -0600624 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
625 if (view_state) {
626 SetImageViewLayout(device_data, cb_state, view_state, rpci->pAttachments[i].initialLayout);
627 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700628 }
629 // Now transition for first subpass (index 0)
630 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
631}
632
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700633void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
Tony-LunarG0d27b302018-10-08 09:26:21 -0600634 uint32_t level, uint32_t layer, VkImageAspectFlags aspect_mask, VkImageAspectFlags aspect) {
635 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700636 return;
637 }
638 VkImageSubresource sub = {aspect, level, layer};
639 IMAGE_CMD_BUF_LAYOUT_NODE node;
640 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700641 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700642 SetLayout(device_data, pCB, mem_barrier->image, sub,
643 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
644 return;
645 }
646 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
647 // TODO: Set memory invalid
648 }
649 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
650}
651
Dave Houlton10b39482017-03-16 13:18:15 -0600652bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600653 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600654 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600655 }
656 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600657 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600658 }
659 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600660 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600661 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700662 if (0 !=
663 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
664 if (FormatPlaneCount(format) == 1) return false;
665 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600666 return true;
667}
668
Mike Weiblen62d08a32017-03-07 22:18:27 -0700669// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
670bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
671 VkImageUsageFlags usage_flags, const char *func_name) {
672 const auto report_data = core_validation::GetReportData(device_data);
673 bool skip = false;
674 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Dave Houlton8e9f6542018-05-18 12:18:22 -0600675 std::string msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700676
677 switch (layout) {
678 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
679 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600680 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700681 }
682 break;
683 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
684 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600685 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700686 }
687 break;
688 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
689 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600690 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700691 }
692 break;
693 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
694 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600695 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700696 }
697 break;
698 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
699 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600700 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700701 }
702 break;
703 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
704 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600705 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700706 }
707 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600708 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500709 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
710 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
711 }
712 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700713 default:
714 // Other VkImageLayout values do not have VUs defined in this context.
715 break;
716 }
717
Dave Houlton8e9f6542018-05-18 12:18:22 -0600718 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600719 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 -0600720 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600721 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
722 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
723 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700724 }
725 return skip;
726}
727
John Zulauf463c51e2018-05-31 13:29:20 -0600728// Scoreboard for checking for duplicate and inconsistent barriers to images
729struct ImageBarrierScoreboardEntry {
730 uint32_t index;
731 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
732 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
733 const VkImageMemoryBarrier *barrier;
734};
735using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
736using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
737
Mike Weiblen62d08a32017-03-07 22:18:27 -0700738// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600739bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700740 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700741 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700742
John Zulauf463c51e2018-05-31 13:29:20 -0600743 // Scoreboard for duplicate layout transition barriers within the list
744 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
745 ImageBarrierScoreboardImageMap layout_transitions;
746
Mike Weiblen62d08a32017-03-07 22:18:27 -0700747 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
748 auto img_barrier = &pImageMemoryBarriers[i];
749 if (!img_barrier) continue;
750
John Zulauf463c51e2018-05-31 13:29:20 -0600751 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
752 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
753 // at a per sub-resource level
754 if (img_barrier->oldLayout != img_barrier->newLayout) {
755 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
756 auto image_it = layout_transitions.find(img_barrier->image);
757 if (image_it != layout_transitions.end()) {
758 auto &subres_map = image_it->second;
759 auto subres_it = subres_map.find(img_barrier->subresourceRange);
760 if (subres_it != subres_map.end()) {
761 auto &entry = subres_it->second;
762 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
763 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
764 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
765 skip = log_msg(
766 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
767 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_state->commandBuffer),
768 "VUID-VkImageMemoryBarrier-oldLayout-01197",
769 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image 0x%" PRIx64
770 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
771 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
772 func_name, i, entry.index, HandleToUint64(img_barrier->image), range.aspectMask, range.baseMipLevel,
773 range.levelCount, range.baseArrayLayer, range.layerCount, string_VkImageLayout(img_barrier->oldLayout),
774 string_VkImageLayout(entry.barrier->newLayout));
775 }
776 entry = new_entry;
777 } else {
778 subres_map[img_barrier->subresourceRange] = new_entry;
779 }
780 } else {
781 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
782 }
783 }
784
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600785 auto image_state = GetImageState(device_data, img_barrier->image);
786 if (image_state) {
787 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
788 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
789 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
790
791 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
792 if (image_state->layout_locked) {
793 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600794 skip |= log_msg(
795 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Young9d1ac312018-05-21 16:28:27 -0600796 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100797 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600798 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Kraus13c98a62017-12-09 00:22:39 +0100799 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600800 string_VkImageLayout(img_barrier->newLayout));
801 }
802 }
803
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600804 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600805 // For a Depth/Stencil image both aspects MUST be set
806 if (FormatIsDepthAndStencil(image_create_info->format)) {
807 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
808 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
809 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600810 skip |=
811 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -0600812 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image),
813 "VUID-VkImageMemoryBarrier-image-01207",
Mark Lobodzinski88529492018-04-01 10:38:15 -0600814 "%s: Image barrier 0x%p references image 0x%" PRIx64
815 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
816 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
817 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600818 }
819 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600820 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
821 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700822
Mike Weiblen62d08a32017-03-07 22:18:27 -0700823 for (uint32_t j = 0; j < level_count; j++) {
824 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
825 for (uint32_t k = 0; k < layer_count; k++) {
826 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600827 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
828 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
829 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
830 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700831 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
832 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
833 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
834 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
835 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
836 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
837 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
838 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700839 }
840 }
841 }
842 return skip;
843}
844
Chris Forbes4de4b132017-08-21 11:27:08 -0700845static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600846 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700847
848 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600849 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700850}
851
John Zulauf6b4aae82018-05-09 13:03:36 -0600852template <typename Barrier>
853bool ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
854 uint32_t barrier_count, const Barrier *barriers) {
855 using BarrierRecord = QFOTransferBarrier<Barrier>;
856 bool skip = false;
857 const auto report_data = core_validation::GetReportData(device_data);
858 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
859 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
860 const char *barrier_name = BarrierRecord::BarrierName();
861 const char *handle_name = BarrierRecord::HandleName();
862 const char *transfer_type = nullptr;
863 for (uint32_t b = 0; b < barrier_count; b++) {
864 if (!IsTransferOp(&barriers[b])) continue;
865 const BarrierRecord *barrier_record = nullptr;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600866 if (IsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600867 const auto found = barrier_sets.release.find(barriers[b]);
868 if (found != barrier_sets.release.cend()) {
869 barrier_record = &(*found);
870 transfer_type = "releasing";
871 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600872 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
873 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600874 const auto found = barrier_sets.acquire.find(barriers[b]);
875 if (found != barrier_sets.acquire.cend()) {
876 barrier_record = &(*found);
877 transfer_type = "acquiring";
878 }
879 }
880 if (barrier_record != nullptr) {
881 skip |=
882 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
883 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
884 "%s: %s at index %" PRIu32 " %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
885 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
886 func_name, barrier_name, b, transfer_type, handle_name, HandleToUint64(barrier_record->handle),
887 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
888 }
889 }
890 return skip;
891}
892
893template <typename Barrier>
894void RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
895 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
896 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
897 for (uint32_t b = 0; b < barrier_count; b++) {
898 if (!IsTransferOp(&barriers[b])) continue;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600899 if (IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600900 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600901 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
902 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600903 barrier_sets.acquire.emplace(barriers[b]);
904 }
905 }
906}
907
908bool ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
909 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
910 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
911 bool skip = false;
912 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
913 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
914 return skip;
915}
916
917void RecordBarriersQFOTransfers(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
918 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
919 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
920 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
921 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
922}
923
924template <typename BarrierRecord, typename Scoreboard>
925static bool ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
926 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
927 // Record to the scoreboard or report that we have a duplication
928 bool skip = false;
929 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
930 if (!inserted.second && inserted.first->second != cb_state) {
931 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
932 skip = log_msg(
933 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
934 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
935 "%s: %s %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
936 " duplicates existing barrier submitted in this batch from command buffer 0x%" PRIx64 ".",
937 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(), HandleToUint64(barrier.handle),
938 barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex, HandleToUint64(inserted.first->second));
939 }
940 return skip;
941}
942
943template <typename Barrier>
944static bool ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
945 QFOTransferCBScoreboards<Barrier> *scoreboards) {
946 using BarrierRecord = QFOTransferBarrier<Barrier>;
947 using TypeTag = typename BarrierRecord::Tag;
948 bool skip = false;
949 const auto report_data = core_validation::GetReportData(device_data);
950 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
951 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
952 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
953 const char *barrier_name = BarrierRecord::BarrierName();
954 const char *handle_name = BarrierRecord::HandleName();
955 // No release should have an extant duplicate (WARNING)
956 for (const auto &release : cb_barriers.release) {
957 // Check the global pending release barriers
958 const auto set_it = global_release_barriers.find(release.handle);
959 if (set_it != global_release_barriers.cend()) {
960 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
961 const auto found = set_for_handle.find(release);
962 if (found != set_for_handle.cend()) {
963 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
964 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
965 "%s: %s releasing queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
966 " to dstQueueFamilyIndex %" PRIu32
967 " duplicates existing barrier queued for execution, without intervening acquire operation.",
968 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(found->handle),
969 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
970 }
971 }
972 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
973 }
974 // Each acquire must have a matching release (ERROR)
975 for (const auto &acquire : cb_barriers.acquire) {
976 const auto set_it = global_release_barriers.find(acquire.handle);
977 bool matching_release_found = false;
978 if (set_it != global_release_barriers.cend()) {
979 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
980 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
981 }
982 if (!matching_release_found) {
983 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
984 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Petr Krausfd505102018-12-17 15:18:01 +0100985 "%s: in submitted command buffer %s acquiring ownership of %s (0x%" PRIx64
John Zulauf6b4aae82018-05-09 13:03:36 -0600986 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
987 " has no matching release barrier queued for execution.",
988 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(acquire.handle),
989 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
990 }
991 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
992 }
993 return skip;
994}
995
996bool ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
997 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
998 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
999 bool skip = false;
1000 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
1001 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
1002 return skip;
1003}
1004
1005template <typename Barrier>
1006static void RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1007 using BarrierRecord = QFOTransferBarrier<Barrier>;
1008 using TypeTag = typename BarrierRecord::Tag;
1009 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
1010 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1011 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
1012
1013 // Add release barriers from this submit to the global map
1014 for (const auto &release : cb_barriers.release) {
1015 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1016 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1017 global_release_barriers[release.handle].insert(release);
1018 }
1019
1020 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1021 for (const auto &acquire : cb_barriers.acquire) {
1022 // NOTE: We're not using [] because we don't want to create entries for missing releases
1023 auto set_it = global_release_barriers.find(acquire.handle);
1024 if (set_it != global_release_barriers.end()) {
1025 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1026 set_for_handle.erase(acquire);
1027 if (set_for_handle.size() == 0) { // Clean up empty sets
1028 global_release_barriers.erase(set_it);
1029 }
1030 }
1031 }
1032}
1033
1034void RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1035 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1036 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1037}
1038
1039// Remove the pending QFO release records from the global set
1040// Note that the type of the handle argument constrained to match Barrier type
1041// The defaulted BarrierRecord argument allows use to declare the type once, but is not intended to be specified by the caller
1042template <typename Barrier, typename BarrierRecord = QFOTransferBarrier<Barrier>>
1043static void EraseQFOReleaseBarriers(layer_data *device_data, const typename BarrierRecord::HandleType &handle) {
1044 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1045 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, typename BarrierRecord::Tag());
1046 global_release_barriers.erase(handle);
1047}
1048
1049// Avoid making the template globally visible by exporting the one instance of it we need.
1050void EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
1051 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1052}
1053
Chris Forbes399a6782017-08-18 15:00:48 -07001054void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001055 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001056 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1057 auto mem_barrier = &pImgMemBarriers[i];
1058 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001059
Chris Forbes4de4b132017-08-21 11:27:08 -07001060 // For ownership transfers, the barrier is specified twice; as a release
1061 // operation on the yielding queue family, and as an acquire operation
1062 // on the acquiring queue family. This barrier may also include a layout
1063 // transition, which occurs 'between' the two operations. For validation
1064 // purposes it doesn't seem important which side performs the layout
1065 // transition, but it must not be performed twice. We'll arbitrarily
1066 // choose to perform it as part of the acquire operation.
1067 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
1068 continue;
1069 }
1070
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001071 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
1072 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1073 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1074
Dave Houltonb3f4b282018-02-22 16:25:16 -07001075 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1076 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1077 // for all (potential) layer sub_resources.
1078 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1079 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1080 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1081 }
1082
Tony-LunarG0d27b302018-10-08 09:26:21 -06001083 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1084 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
1085 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1086 if (FormatIsMultiplane(image_create_info->format)) {
1087 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1088 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1089 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1090 if (FormatPlaneCount(image_create_info->format) > 2) {
1091 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1092 }
1093 }
1094 }
1095 }
1096
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001097 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001098 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001099 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001100 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Tony-LunarG0d27b302018-10-08 09:26:21 -06001101 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1102 VK_IMAGE_ASPECT_COLOR_BIT);
1103 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1104 VK_IMAGE_ASPECT_DEPTH_BIT);
1105 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1106 VK_IMAGE_ASPECT_STENCIL_BIT);
1107 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1108 VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001109 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001110 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1111 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1112 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1113 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1114 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1115 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001116 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001117 }
1118 }
1119 }
1120}
1121
Tobin Ehlisc8266452017-04-07 12:20:30 -06001122bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001123 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07001124 const char *caller, const std::string &layout_invalid_msg_code, const std::string &layout_mismatch_msg_code,
1125 bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001126 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001127 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001128 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001129
1130 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1131 uint32_t layer = i + subLayers.baseArrayLayer;
1132 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1133 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001134 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1135 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001136 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001137 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1138 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1139 "%s: Cannot use image 0x%" PRIx64
1140 " (layer=%u mip=%u) with specific layout %s that doesn't match the actual current layout %s.",
1141 caller, HandleToUint64(image), layer, subLayers.mipLevel, string_VkImageLayout(explicit_layout),
1142 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001143 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001144 }
1145 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001146 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1147 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1148 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001149 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1150 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001151 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001152 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001153 kVUID_Core_DrawState_InvalidImageLayout,
Petr Kraus13c98a62017-12-09 00:22:39 +01001154 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
1155 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001156 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001157 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001158 if (image_state->shared_presentable) {
1159 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001160 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1161 layout_invalid_msg_code,
1162 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1163 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001164 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001165 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001166 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001167 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001168 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 -07001169 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001170 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1171 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001172 }
1173 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001174 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001175}
1176
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001177void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
1178 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001179 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001180 if (!renderPass) return;
1181
Tobias Hectorbbb12282018-10-22 15:17:59 +01001182 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001183 if (framebuffer_state) {
1184 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -06001185 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
1186 if (view_state) {
1187 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
1188 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001189 }
1190 }
1191}
Dave Houltone19e20d2018-02-02 16:32:41 -07001192
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001193#ifdef VK_USE_PLATFORM_ANDROID_KHR
1194// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1195// This could also move into a seperate core_validation_android.cpp file... ?
1196
1197//
1198// AHB-specific validation within non-AHB APIs
1199//
1200bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1201 const VkImageCreateInfo *create_info) {
1202 bool skip = false;
1203
1204 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1205 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001206 if (0 != ext_fmt_android->externalFormat) {
1207 if (VK_FORMAT_UNDEFINED != create_info->format) {
1208 skip |=
1209 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1210 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001211 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001212 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1213 }
1214
1215 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1216 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1217 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001218 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001219 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1220 }
1221
1222 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1223 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1224 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001225 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001226 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1227 }
1228
1229 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1230 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1231 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001232 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001233 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1234 }
1235 }
1236
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001237 auto ahb_formats = GetAHBExternalFormatsSet(device_data);
1238 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1239 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1240 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001241 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001242 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1243 }
1244 }
1245
Dave Houltond9611312018-11-19 17:03:36 -07001246 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001247 if (VK_FORMAT_UNDEFINED == create_info->format) {
1248 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1249 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001250 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001251 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1252 }
1253 }
1254
1255 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1256 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1257 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001258 skip |=
1259 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1260 "VUID-VkImageCreateInfo-pNext-02393",
1261 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1262 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1263 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001264 }
1265
1266 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1267 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1268 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001269 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001270 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1271 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1272 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1273 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001274 }
1275
1276 return skip;
1277}
1278
1279void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
1280 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1281 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1282 is_node->imported_ahb = true;
1283 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001284 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1285 if (ext_fmt_android) {
1286 is_node->has_ahb_format = true;
1287 is_node->ahb_format = ext_fmt_android->externalFormat;
1288 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001289}
1290
1291bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
1292 bool skip = false;
1293 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houltond3e046d2018-11-28 13:08:09 -07001294 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
1295
1296 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001297 if (VK_FORMAT_UNDEFINED != create_info->format) {
1298 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1299 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1300 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1301 "format member is %s.",
1302 string_VkFormat(create_info->format));
1303 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304
Dave Houltond9611312018-11-19 17:03:36 -07001305 // Chain must include a compatible ycbcr conversion
1306 bool conv_found = false;
1307 uint64_t external_format = 0;
1308 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1309 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001310 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
1311 auto fmap = GetYcbcrConversionFormatMap(device_data);
Dave Houltond9611312018-11-19 17:03:36 -07001312 if (fmap->find(conv_handle) != fmap->end()) {
1313 conv_found = true;
1314 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001315 }
Dave Houltond9611312018-11-19 17:03:36 -07001316 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001317 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001318 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 -07001319 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1320 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1321 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1322 }
1323
1324 // Errors in create_info swizzles
1325 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1326 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1327 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1328 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1329 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1330 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1331 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1332 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001333 }
1334 }
Dave Houltond9611312018-11-19 17:03:36 -07001335
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001336 return skip;
1337}
1338
1339bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
1340 bool skip = false;
1341 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1342
1343 IMAGE_STATE *image_state = GetImageState(device_data, image);
1344 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1345 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1346 "VUID-vkGetImageSubresourceLayout-image-01895",
1347 "vkGetImageSubresourceLayout: Attempt to query layout from an image created with "
1348 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1349 "bound to memory.");
1350 }
1351 return skip;
1352}
1353
1354#else
1355
1356bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1357 const VkImageCreateInfo *create_info) {
1358 return false;
1359}
1360
1361void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
1362
1363bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
1364
1365bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
1366
1367#endif // VK_USE_PLATFORM_ANDROID_KHR
1368
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001369bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001370 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001371 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001372 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1373
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001374 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1375 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1376 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1377 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1378 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1379 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001380 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001381 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001382 }
1383
Dave Houlton130c0212018-01-29 13:39:56 -07001384 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001385 skip |= log_msg(
1386 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1387 "VUID-VkImageCreateInfo-flags-00949",
1388 "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 -07001389 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001390
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07001391 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001392 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1393 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1394 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001395 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 +00001396 "VUID-VkImageCreateInfo-usage-00964",
1397 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1398 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001399 }
1400
1401 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001402 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 +00001403 "VUID-VkImageCreateInfo-usage-00965",
1404 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1405 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001406 }
1407
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001408 VkImageFormatProperties format_limits = {};
1409 VkResult res = GetPDImageFormatProperties(device_data, pCreateInfo, &format_limits);
1410 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1411 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1412 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1413 string_VkFormat(pCreateInfo->format));
1414 } else {
1415 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1416 const char *format_string = string_VkFormat(pCreateInfo->format);
1417 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1418 "VUID-VkImageCreateInfo-mipLevels-02255",
1419 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1420 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1421 }
Dave Houlton130c0212018-01-29 13:39:56 -07001422
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001423 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1424 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1425 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -07001426
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001427 // Round up to imageGranularity boundary
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07001428 VkDeviceSize imageGranularity = GetPDProperties(device_data)->limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001429 uint64_t ig_mask = imageGranularity - 1;
1430 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001431
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001432 if (total_size > format_limits.maxResourceSize) {
1433 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1434 kVUID_Core_Image_InvalidFormatLimitsViolation,
1435 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1436 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1437 total_size, format_limits.maxResourceSize);
1438 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001439
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001440 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1441 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1442 "VUID-VkImageCreateInfo-arrayLayers-02256",
1443 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1444 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1445 }
1446
1447 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1448 skip |=
1449 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1450 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001451 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001452 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001453 }
1454
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06001455 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) &&
1456 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001457 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 -06001458 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001459 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1460 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001461 }
1462
Lenny Komowb79f04a2017-09-18 17:07:00 -06001463 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1464 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1465 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1466 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1467 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001468 skip |=
1469 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1470 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1471 "format must be block, ETC or ASTC compressed, but is %s",
1472 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001473 }
1474 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1475 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001476 skip |=
1477 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1478 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1479 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001480 }
1481 }
1482 }
1483
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001484 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001485}
1486
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001487void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001488 IMAGE_LAYOUT_NODE image_state;
1489 image_state.layout = pCreateInfo->initialLayout;
1490 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001491 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
1492 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1493 RecordCreateImageANDROID(pCreateInfo, is_node);
1494 }
1495 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001496 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001497 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1498 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001499}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001500
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001501bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001502 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001503 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +02001504 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001505 if (disabled->destroy_image) return false;
1506 bool skip = false;
1507 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06001508 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001509 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001510 }
1511 return skip;
1512}
1513
John Zulauffca05c12018-04-26 16:30:39 -06001514void PreCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001515 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001516 // Clean up memory mapping, bindings and range references for image
1517 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001518 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001519 if (mem_info) {
1520 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1521 }
1522 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001523 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001524 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001525 // Remove image from imageMap
1526 core_validation::GetImageMap(device_data)->erase(image);
1527 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1528 core_validation::GetImageSubresourceMap(device_data);
1529
1530 const auto &sub_entry = imageSubresourceMap->find(image);
1531 if (sub_entry != imageSubresourceMap->end()) {
1532 for (const auto &pair : sub_entry->second) {
1533 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1534 }
1535 imageSubresourceMap->erase(sub_entry);
1536 }
1537}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001538
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001539bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001540 bool skip = false;
1541 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1542
1543 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1544 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1545 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 -06001546 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001547 }
1548
Dave Houlton1d2022c2017-03-29 11:43:58 -06001549 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001550 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1551 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 -06001552 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001553 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001554 char const str[] = "vkCmdClearColorImage called with compressed image.";
1555 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 -06001556 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001557 }
1558
1559 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1560 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1561 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 -06001562 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001563 }
1564 return skip;
1565}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001566
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001567uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1568 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1569 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001570 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001571 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001572 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001573 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001574}
1575
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001576uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1577 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1578 uint32_t array_layer_count = range->layerCount;
1579 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1580 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001581 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001582 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001583}
1584
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001585bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001586 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1587 bool skip = false;
1588 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1589
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001590 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1591 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001592
1593 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1594 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001595 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1596 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001597 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 -06001598 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001599 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1600 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001601 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001602 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001603 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001604 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 -06001605 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001606 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1607 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001608
1609 } else {
1610 if (image_state->shared_presentable) {
1611 skip |= log_msg(
1612 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001613 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001614 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1615 string_VkImageLayout(dest_image_layout));
1616 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001617 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001618 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001619 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001620 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001621 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001622 } else {
1623 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1624 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001625 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001626 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001627 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1628 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001629 }
1630 }
1631
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001632 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1633 uint32_t level = level_index + range.baseMipLevel;
1634 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1635 uint32_t layer = layer_index + range.baseArrayLayer;
1636 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001637 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001638 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001639 if (node.layout != dest_image_layout) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001640 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001641 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001642 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643 } else {
1644 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1645 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001646 skip |=
1647 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1648 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1649 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001650 }
1651 }
1652 }
1653 }
1654
1655 return skip;
1656}
1657
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001658void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1659 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001660 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1661 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1662 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001663
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001664 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1665 uint32_t level = level_index + range.baseMipLevel;
1666 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1667 uint32_t layer = layer_index + range.baseArrayLayer;
1668 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001669 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001670 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1671 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 -07001672 }
1673 }
1674 }
1675}
1676
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001677bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001678 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1679 bool skip = false;
1680 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001681 auto cb_node = GetCBNode(dev_data, commandBuffer);
1682 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001683 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001684 skip |=
1685 ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001686 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001687 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001688 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001689 if (GetApiVersion(dev_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001690 skip |=
1691 ValidateImageFormatFeatureFlags(dev_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001692 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001693 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001694 skip |= InsideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001695 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001696 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001697 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001698 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001699 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001700 }
1701 }
1702 return skip;
1703}
1704
1705// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001706void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001707 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001708 auto cb_node = GetCBNode(dev_data, commandBuffer);
1709 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001710 if (cb_node && image_state) {
1711 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001712 for (uint32_t i = 0; i < rangeCount; ++i) {
1713 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1714 }
1715 }
1716}
1717
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001718bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1719 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001720 const VkImageSubresourceRange *pRanges) {
1721 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001722 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1723
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001724 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001725 auto cb_node = GetCBNode(device_data, commandBuffer);
1726 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001727 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001728 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1729 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001730 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001731 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001732 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001733 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1734 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001735 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1736 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001737 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001738 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001739 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001740 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001741 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001742 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001743 skip |=
1744 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001745 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001746 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1747 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001748 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001749 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1750 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001751 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 -06001752 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001753 }
1754 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001755 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001756 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001757 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 -06001758 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001759 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001760 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1761 char const str[] =
1762 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1763 "set.";
1764 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 -06001765 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001766 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001767 }
1768 return skip;
1769}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001770
1771// Returns true if [x, xoffset] and [y, yoffset] overlap
1772static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1773 bool result = false;
1774 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1775 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1776
1777 if (intersection_max > intersection_min) {
1778 result = true;
1779 }
1780 return result;
1781}
1782
Dave Houltonc991cc92018-03-06 11:08:51 -07001783// Returns true if source area of first copy region intersects dest area of second region
1784// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1785static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001786 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001787
Dave Houltonc991cc92018-03-06 11:08:51 -07001788 // Separate planes within a multiplane image cannot intersect
1789 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001790 return result;
1791 }
1792
Dave Houltonc991cc92018-03-06 11:08:51 -07001793 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1794 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1795 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001796 result = true;
1797 switch (type) {
1798 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001799 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001800 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001801 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001802 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001803 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001804 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001805 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001806 break;
1807 default:
1808 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1809 assert(false);
1810 }
1811 }
1812 return result;
1813}
1814
Dave Houltonfc1a4052017-04-27 14:32:45 -06001815// Returns non-zero if offset and extent exceed image extents
1816static const uint32_t x_bit = 1;
1817static const uint32_t y_bit = 2;
1818static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001819static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001820 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001821 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001822 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1823 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001824 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001825 }
1826 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1827 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001828 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001829 }
1830 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1831 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001832 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001833 }
1834 return result;
1835}
1836
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001837// Test if two VkExtent3D structs are equivalent
1838static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1839 bool result = true;
1840 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1841 (extent->depth != other_extent->depth)) {
1842 result = false;
1843 }
1844 return result;
1845}
1846
Dave Houltonee281a52017-12-08 13:51:02 -07001847// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1848// Destination image texel extents must be adjusted by block size for the dest validation checks
1849VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1850 VkExtent3D adjusted_extent = extent;
1851 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1852 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1853 adjusted_extent.width /= block_size.width;
1854 adjusted_extent.height /= block_size.height;
1855 adjusted_extent.depth /= block_size.depth;
1856 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1857 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1858 adjusted_extent.width *= block_size.width;
1859 adjusted_extent.height *= block_size.height;
1860 adjusted_extent.depth *= block_size.depth;
1861 }
1862 return adjusted_extent;
1863}
1864
Dave Houlton6f9059e2017-05-02 17:15:13 -06001865// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001866static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1867 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001868
1869 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001870 if (mip >= img->createInfo.mipLevels) {
1871 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001872 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001873
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001874 // 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 -06001875 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001876
Dave Houltone48cd112019-01-03 17:01:18 -07001877 // If multi-plane, adjust per-plane extent
1878 if (FormatIsMultiplane(img->createInfo.format)) {
1879 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1880 extent.width /= divisors.width;
1881 extent.height /= divisors.height;
1882 }
1883
Jeff Bolzef40fec2018-09-01 22:04:34 -05001884 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1885 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001886 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001887 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1888 } else {
1889 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1890 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1891 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1892 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001893
Dave Houlton6f9059e2017-05-02 17:15:13 -06001894 // Image arrays have an effective z extent that isn't diminished by mip level
1895 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001896 extent.depth = img->createInfo.arrayLayers;
1897 }
1898
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001899 return extent;
1900}
1901
1902// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001903static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001904 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1905}
1906
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001907// Test if the extent argument has any dimensions set to 0.
1908static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1909 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1910}
1911
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001912// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1913static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1914 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1915 VkExtent3D granularity = {0, 0, 0};
1916 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1917 if (pPool) {
1918 granularity =
1919 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001920 if (FormatIsCompressed(img->createInfo.format)) {
1921 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001922 granularity.width *= block_size.width;
1923 granularity.height *= block_size.height;
1924 }
1925 }
1926 return granularity;
1927}
1928
1929// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1930static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1931 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001932 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1933 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001934 valid = false;
1935 }
1936 return valid;
1937}
1938
1939// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1940static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001941 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001942 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001943 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1944 bool skip = false;
1945 VkExtent3D offset_extent = {};
1946 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1947 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1948 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001949 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001950 // 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 -07001951 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001952 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 -04001953 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001954 "%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 "
1955 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001956 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001957 }
1958 } else {
1959 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1960 // integer multiples of the image transfer granularity.
1961 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001962 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 -04001963 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001964 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1965 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001966 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1967 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001968 }
1969 }
1970 return skip;
1971}
1972
1973// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1974static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1975 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001976 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001977 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001978 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1979 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001980 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001981 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1982 // subresource extent.
1983 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001984 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 -04001985 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001986 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1987 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1988 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1989 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001990 }
1991 } else {
1992 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1993 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1994 // subresource extent dimensions.
1995 VkExtent3D offset_extent_sum = {};
1996 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1997 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1998 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001999 bool x_ok = true;
2000 bool y_ok = true;
2001 bool z_ok = true;
2002 switch (image_type) {
2003 case VK_IMAGE_TYPE_3D:
2004 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2005 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002006 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002007 case VK_IMAGE_TYPE_2D:
2008 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2009 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002010 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002011 case VK_IMAGE_TYPE_1D:
2012 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2013 (subresource_extent->width == offset_extent_sum.width));
2014 break;
2015 default:
2016 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2017 assert(false);
2018 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002019 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002020 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 -04002021 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002022 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2023 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2024 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2025 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2026 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2027 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002028 }
2029 }
2030 return skip;
2031}
2032
Cort Strattonff1542a2018-05-27 10:49:28 -07002033bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
2034 const uint32_t i, const char *function, const char *member, const std::string &vuid) {
2035 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2036 bool skip = false;
2037 if (mip_level >= img->createInfo.mipLevels) {
2038 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2039 HandleToUint64(cb_node->commandBuffer), vuid,
2040 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
2041 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
2042 }
2043 return skip;
2044}
2045
2046bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2047 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
2048 const char *member, const std::string &vuid) {
2049 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2050 bool skip = false;
2051 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2052 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2053 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2054 HandleToUint64(cb_node->commandBuffer), vuid,
2055 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2056 "%u, but provided image %" PRIx64 " has %u array layers.",
2057 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
2058 }
2059 return skip;
2060}
2061
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002062// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002063bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2064 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Dave Houltone0969282018-05-23 15:54:31 -06002065 const uint32_t i, const char *function, const std::string &vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002066 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002067 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2068 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2069 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2070 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2071 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002072 return skip;
2073}
2074
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002075// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002076bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002077 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2078 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002079 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002080 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002081 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002082 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2083 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002084 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002085 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002086 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002087 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002088
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002089 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002090 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002091 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2092 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002093 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002094 const VkExtent3D dest_effective_extent =
2095 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002096 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002097 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002098 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002099 return skip;
2100}
2101
Dave Houlton6f9059e2017-05-02 17:15:13 -06002102// Validate contents of a VkImageCopy struct
2103bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
2104 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
2105 bool skip = false;
2106
2107 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002108 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002109
2110 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002111 const VkExtent3D src_copy_extent = region.extent;
2112 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002113 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2114
Dave Houlton6f9059e2017-05-02 17:15:13 -06002115 bool slice_override = false;
2116 uint32_t depth_slices = 0;
2117
2118 // Special case for copying between a 1D/2D array and a 3D image
2119 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2120 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002121 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002122 slice_override = (depth_slices != 1);
2123 } 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 -07002124 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002125 slice_override = (depth_slices != 1);
2126 }
2127
2128 // Do all checks on source image
2129 //
2130 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002131 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2132 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 -06002133 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002134 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002135 "be 0 and 1, respectively.",
2136 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002137 }
2138 }
2139
Dave Houlton533be9f2018-03-26 17:08:30 -06002140 // VUID-VkImageCopy-srcImage-01785
2141 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2142 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 -06002143 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002144 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002145 "these must be 0 and 1, respectively.",
2146 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002147 }
2148
Dave Houlton533be9f2018-03-26 17:08:30 -06002149 // VUID-VkImageCopy-srcImage-01787
2150 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2151 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 -06002152 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002153 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2154 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002155 }
2156
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002157 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002158 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002159 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002160 skip |=
2161 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002162 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002163 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002164 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2165 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002166 }
2167 }
2168 } else { // Pre maint 1
2169 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002170 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002171 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 -06002172 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002173 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2174 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002175 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2176 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002177 }
2178 }
2179 }
2180
Dave Houltonc991cc92018-03-06 11:08:51 -07002181 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2182 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
2183 if (FormatIsCompressed(src_state->createInfo.format) ||
2184 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002185 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002186 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002187 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2188 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2189 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002190 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002191 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 -07002192 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002193 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002194 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002195 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002196 }
2197
Dave Houlton94a00372017-12-14 15:08:47 -07002198 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002199 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2200 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002201 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002202 skip |=
2203 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002204 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002205 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002206 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002207 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002208 }
2209
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002210 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002211 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2212 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002213 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002214 skip |=
2215 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002216 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002217 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002218 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002219 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002220 }
2221
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002222 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002223 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2224 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002225 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002226 skip |=
2227 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002228 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002229 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002230 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002231 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002232 }
2233 } // Compressed
2234
2235 // Do all checks on dest image
2236 //
2237 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002238 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002239 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 -06002240 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002241 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002242 "these must be 0 and 1, respectively.",
2243 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002244 }
2245 }
2246
Dave Houlton533be9f2018-03-26 17:08:30 -06002247 // VUID-VkImageCopy-dstImage-01786
2248 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2249 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 -06002250 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002251 "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 -06002252 "and 1, respectively.",
2253 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002254 }
2255
2256 // VUID-VkImageCopy-dstImage-01788
2257 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2258 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 -06002259 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002260 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2261 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002262 }
2263
2264 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002265 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002266 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 -06002267 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002268 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002269 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2270 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002271 }
2272 }
2273 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002274 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002275 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002276 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002277 skip |=
2278 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002279 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002280 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002281 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2282 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002283 }
2284 }
2285 } else { // Pre maint 1
2286 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002287 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002288 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 -06002289 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002290 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2291 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002292 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2293 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002294 }
2295 }
2296 }
2297
Dave Houltonc991cc92018-03-06 11:08:51 -07002298 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2299 if (FormatIsCompressed(dst_state->createInfo.format) ||
2300 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002301 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002302
2303 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002304 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2305 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2306 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002307 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002308 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 -07002309 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002310 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002311 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002312 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002313 }
2314
Dave Houlton94a00372017-12-14 15:08:47 -07002315 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002316 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2317 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002318 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002319 skip |=
2320 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002321 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002322 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002323 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002324 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002325 }
2326
Dave Houltonee281a52017-12-08 13:51:02 -07002327 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2328 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2329 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002330 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002331 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 -07002332 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002333 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2334 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002335 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002336 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002337 }
2338
Dave Houltonee281a52017-12-08 13:51:02 -07002339 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2340 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2341 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002342 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002343 skip |=
2344 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 width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002347 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002348 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002349 }
2350 } // Compressed
2351 }
2352 return skip;
2353}
2354
Dave Houltonc991cc92018-03-06 11:08:51 -07002355// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2356bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2357 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2358 bool skip = false;
2359 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2360
2361 // Neither image is multiplane
2362 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2363 // If neither image is multi-plane the aspectMask member of src and dst must match
2364 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2365 std::stringstream ss;
2366 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
2367 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2368 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 -06002369 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002370 }
2371 } else {
2372 // Source image multiplane checks
2373 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2374 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2375 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2376 std::stringstream ss;
2377 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2378 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 -06002379 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002380 }
2381 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2382 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2383 std::stringstream ss;
2384 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2385 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 -06002386 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002387 }
2388 // Single-plane to multi-plane
2389 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2390 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2391 std::stringstream ss;
2392 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2393 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 -06002394 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002395 }
2396
2397 // Dest image multiplane checks
2398 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2399 aspect = region.dstSubresource.aspectMask;
2400 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2401 std::stringstream ss;
2402 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2403 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 -06002404 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002405 }
2406 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2407 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2408 std::stringstream ss;
2409 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2410 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 -06002411 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002412 }
2413 // Multi-plane to single-plane
2414 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2415 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2416 std::stringstream ss;
2417 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2418 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002419 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002420 }
2421 }
2422
2423 return skip;
2424}
2425
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002426bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002427 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2428 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002429 bool skip = false;
2430 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002431 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
2432
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002433 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2434
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002435 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002436 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002437
2438 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2439 VkExtent3D src_copy_extent = region.extent;
2440 VkExtent3D dst_copy_extent =
2441 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2442
Dave Houlton6f9059e2017-05-02 17:15:13 -06002443 bool slice_override = false;
2444 uint32_t depth_slices = 0;
2445
2446 // Special case for copying between a 1D/2D array and a 3D image
2447 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2448 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2449 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002450 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002451 slice_override = (depth_slices != 1);
2452 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2453 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002454 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002455 slice_override = (depth_slices != 1);
2456 }
2457
Cort Strattond619a302018-05-17 19:46:32 -07002458 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2459 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002460 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2461 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2462 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2463 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2464 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2465 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2466 "VUID-vkCmdCopyImage-srcSubresource-01698");
2467 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2468 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2469 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002470
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002471 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002472 // No chance of mismatch if we're overriding depth slice count
2473 if (!slice_override) {
2474 // The number of depth slices in srcSubresource and dstSubresource must match
2475 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2476 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002477 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2478 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002479 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002480 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2481 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002482 if (src_slices != dst_slices) {
2483 std::stringstream ss;
2484 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
2485 << "] do not match";
2486 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 -06002487 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002488 }
2489 }
2490 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002491 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002492 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002493 std::stringstream ss;
2494 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
2495 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002496 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 -06002497 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002498 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002499 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002500
Dave Houltonc991cc92018-03-06 11:08:51 -07002501 // Do multiplane-specific checks, if extension enabled
2502 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2503 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2504 }
2505
Dave Houltonf5217612018-02-02 16:18:52 -07002506 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2507 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2508 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2509 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
2510 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 -06002511 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002512 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002513 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002514
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002515 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002516 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002517 std::stringstream ss;
2518 ss << "vkCmdCopyImage: pRegion[" << i
2519 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2520 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 -06002521 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002522 }
2523
2524 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002525 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002526 std::stringstream ss;
2527 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2528 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 -06002529 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002530 }
2531
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002532 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2533 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2534 // 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 -07002535 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2536 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002537 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002538 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
2539 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2540 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2541 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002542 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 -06002543 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002544 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002545
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002546 // 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 -07002547 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2548 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002549 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002550 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2551 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2552 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2553 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002554 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 -06002555 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002556 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002557 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002558
Dave Houltonfc1a4052017-04-27 14:32:45 -06002559 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002560 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2561 if (slice_override) src_copy_extent.depth = depth_slices;
2562 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002563 if (extent_check & x_bit) {
2564 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002565 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002566 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002567 "width [%1d].",
2568 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002569 }
2570
2571 if (extent_check & y_bit) {
2572 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 -06002573 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002574 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002575 "height [%1d].",
2576 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002577 }
2578 if (extent_check & z_bit) {
2579 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 -06002580 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002581 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002582 "depth [%1d].",
2583 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002584 }
2585
Dave Houltonee281a52017-12-08 13:51:02 -07002586 // Adjust dest extent if necessary
2587 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2588 if (slice_override) dst_copy_extent.depth = depth_slices;
2589
2590 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002591 if (extent_check & x_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-dstOffset-00150",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002594 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002595 "width [%1d].",
2596 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002597 }
2598 if (extent_check & y_bit) {
2599 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 -06002600 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002601 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002602 "height [%1d].",
2603 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002604 }
2605 if (extent_check & z_bit) {
2606 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 -06002607 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002608 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002609 "depth [%1d].",
2610 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002611 }
2612
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002613 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2614 // must not overlap in memory
2615 if (src_image_state->image == dst_image_state->image) {
2616 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002617 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2618 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002619 std::stringstream ss;
2620 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2621 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 -06002622 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002623 }
2624 }
2625 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002627
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002628 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2629 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2630 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002631 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002632 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2633 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002634 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 -06002635 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002636 }
2637 } else {
Tony-LunarG7482ca92018-10-01 14:20:22 -06002638 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, region_count, regions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002639 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2640 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 -06002641 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002642 }
2643 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002644
Dave Houlton33c22b72017-02-28 13:16:02 -07002645 // Source and dest image sample counts must match
2646 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2647 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2648 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002649 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002650 }
2651
Dave Houltond8ed0212018-05-16 17:18:24 -06002652 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2653 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002654 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002655 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2656 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2657 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2658 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002659 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002660 skip |=
2661 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002662 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002663 skip |=
2664 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002665 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002666 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002667 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002668 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2669 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002670 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002671 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002672 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07002673 const std::string invalid_src_layout_vuid =
2674 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2675 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2676 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2677 const std::string invalid_dst_layout_vuid =
2678 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2679 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2680 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002681 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002682 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002683 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2684 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002685 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002686 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2687 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002688 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2689 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002690 }
2691
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002692 return skip;
2693}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002694
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002695void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002696 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2697 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2698 // Make sure that all image slices are updated to correct layout
2699 for (uint32_t i = 0; i < region_count; ++i) {
2700 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2701 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2702 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002703 // Update bindings between images and cmd buffer
2704 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2705 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002706}
2707
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002708// Returns true if sub_rect is entirely contained within rect
2709static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2710 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2711 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2712 return false;
2713 return true;
2714}
2715
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002716bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2717 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002718 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002719 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2720
2721 bool skip = false;
2722 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002723 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002724 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002725 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002726 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002727 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002728 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2729 // 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 -07002730 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2731 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002732 skip |= log_msg(
2733 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002734 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002735 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2736 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2737 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002738 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002739 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002740 }
2741
2742 // Validate that attachment is in reference list of active subpass
2743 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002744 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2745 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002746 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002747
2748 for (uint32_t i = 0; i < attachmentCount; i++) {
2749 auto clear_desc = &pAttachments[i];
2750 VkImageView image_view = VK_NULL_HANDLE;
2751
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002752 if (0 == clear_desc->aspectMask) {
2753 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 -06002754 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002755 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2756 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 -06002757 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002758 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002759 if ((subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment != VK_ATTACHMENT_UNUSED) &&
2760 (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002761 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 -07002762 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2763 "vkCmdClearAttachments() color attachment index %d is not VK_ATTACHMENT_UNUSED and is out of "
2764 "range for active subpass %d.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002765 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002766 } else {
2767 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002768 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002769 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002770 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2771 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2772 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002773 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002774 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 -06002775 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002776 }
2777 } else { // Must be depth and/or stencil
2778 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2779 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002780 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002781 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 -06002782 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002783 }
2784 if (!subpass_desc->pDepthStencilAttachment ||
2785 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2786 skip |= log_msg(
2787 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002788 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002789 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002790 } else {
2791 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2792 }
2793 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002794 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002795 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002796 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002797 // The rectangular region specified by a given element of pRects must be contained within the render area of
2798 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002799 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2800 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2801 skip |=
2802 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 -06002803 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002804 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002805 "the current render pass instance.",
2806 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002807 }
2808 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002809 const auto local_rect =
2810 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002811 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002812 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002813 return log_msg(
2814 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002815 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002816 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002817 "the current render pass instance.",
2818 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002819 }
2820 return false;
2821 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002822 }
2823 // The layers specified by a given element of pRects must be contained within every attachment that
2824 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002825 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002826 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2827 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002828 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 -06002829 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00017",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002830 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002831 "of pAttachment[%d].",
2832 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002833 }
2834 }
2835 }
2836 }
2837 }
2838 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002839}
2840
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002841bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Cort Stratton7df30962018-05-17 19:45:57 -07002842 VkImageLayout src_image_layout, IMAGE_STATE *dst_image_state, VkImageLayout dst_image_layout,
2843 uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002844 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002845 bool skip = false;
2846 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002847 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2848 "VUID-vkCmdResolveImage-srcImage-00256");
2849 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2850 "VUID-vkCmdResolveImage-dstImage-00258");
2851 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2852 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002853 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002854 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002855 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002856 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2857 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002858
Cort Stratton7df30962018-05-17 19:45:57 -07002859 bool hit_error = false;
2860 const std::string invalid_src_layout_vuid =
2861 (src_image_state->shared_presentable &&
2862 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2863 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2864 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2865 const std::string invalid_dst_layout_vuid =
2866 (dst_image_state->shared_presentable &&
2867 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2868 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2869 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002870 // For each region, the number of layers in the image subresource should not be zero
2871 // For each region, src and dest image aspect must be color only
2872 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002873 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2874 "srcSubresource", i);
2875 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2876 "dstSubresource", i);
Cort Stratton7df30962018-05-17 19:45:57 -07002877 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, src_image_layout,
2878 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2879 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
2880 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dst_image_layout,
2881 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2882 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002883 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2884 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2885 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2886 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2887 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2888 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2889 "VUID-vkCmdResolveImage-srcSubresource-01711");
2890 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2891 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2892 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002893
2894 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002895 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2896 skip |= log_msg(
2897 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002898 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002899 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002900 }
Cort Stratton7df30962018-05-17 19:45:57 -07002901 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002902 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2903 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2904 char const str[] =
2905 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2906 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 -06002907 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002908 }
2909 }
2910
2911 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2912 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002913 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 -06002914 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002915 }
2916 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2917 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002918 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 -06002919 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002920 }
2921 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2922 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2923 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 -06002924 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002925 }
2926 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2927 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2928 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 -06002929 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002930 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002931 } else {
2932 assert(0);
2933 }
2934 return skip;
2935}
2936
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002937void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2938 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002939 // Update bindings between images and cmd buffer
2940 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2941 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002942}
2943
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002944bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002945 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2946 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002947 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2948
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002949 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002950 if (cb_node) {
2951 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2952 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002953 if (cb_node && src_image_state && dst_image_state) {
2954 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002955 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002956 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002957 "VUID-vkCmdBlitImage-dstImage-00234");
2958 skip |=
2959 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2960 skip |=
2961 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
2962 skip |=
2963 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2964 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2965 skip |=
2966 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2967 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2968 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
2969 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002970 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002971 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002972 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002973 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04002974 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002975 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002976
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002977 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002978
Dave Houlton33c2d252017-06-09 17:08:32 -06002979 VkFormat src_format = src_image_state->createInfo.format;
2980 VkFormat dst_format = dst_image_state->createInfo.format;
2981 VkImageType src_type = src_image_state->createInfo.imageType;
2982 VkImageType dst_type = dst_image_state->createInfo.imageType;
2983
Cort Stratton186b1a22018-05-01 20:18:06 -04002984 if (VK_FILTER_LINEAR == filter) {
2985 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002986 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2987 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002988 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002989 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
2990 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002991 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002992 }
2993
2994 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2995 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 -06002996 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002997 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002998 }
2999
Dave Houlton33c2d252017-06-09 17:08:32 -06003000 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3001 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3002 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 -06003003 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003004 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003005 }
3006
3007 // Validate consistency for unsigned formats
3008 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3009 std::stringstream ss;
3010 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
3011 << "the other one must also have unsigned integer format. "
3012 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3013 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 -06003014 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003015 }
3016
3017 // Validate consistency for signed formats
3018 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3019 std::stringstream ss;
3020 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
3021 << "the other one must also have signed integer format. "
3022 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3023 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 -06003024 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003025 }
3026
3027 // Validate filter for Depth/Stencil formats
3028 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3029 std::stringstream ss;
3030 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
3031 << "then filter must be VK_FILTER_NEAREST.";
3032 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003033 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003034 }
3035
3036 // Validate aspect bits and formats for depth/stencil images
3037 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3038 if (src_format != dst_format) {
3039 std::stringstream ss;
3040 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
3041 << "stencil, the other one must have exactly the same format. "
3042 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3043 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003044 skip |=
3045 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3046 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003047 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003048 } // Depth or Stencil
3049
3050 // Do per-region checks
Cort Stratton7df30962018-05-17 19:45:57 -07003051 const std::string invalid_src_layout_vuid =
3052 (src_image_state->shared_presentable &&
3053 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3054 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3055 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3056 const std::string invalid_dst_layout_vuid =
3057 (dst_image_state->shared_presentable &&
3058 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3059 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3060 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003061 for (uint32_t i = 0; i < region_count; i++) {
3062 const VkImageBlit rgn = regions[i];
3063 bool hit_error = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06003064 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003065 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3066 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Dave Houltond8ed0212018-05-16 17:18:24 -06003067 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003068 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3069 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003070 skip |=
3071 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3072 skip |=
3073 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003074 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3075 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3076 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3077 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3078 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3079 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3080 "VUID-vkCmdBlitImage-srcSubresource-01707");
3081 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3082 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3083 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003084 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003085 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3086 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003087 std::stringstream ss;
3088 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003089 skip |=
3090 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3091 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003092 }
Dave Houlton48989f32017-05-26 15:01:46 -06003093 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3094 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003095 std::stringstream ss;
3096 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003097 skip |=
3098 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3099 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003100 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003101
3102 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003103 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003104 skip |=
3105 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 -06003106 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003107 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003108 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003109
Dave Houlton48989f32017-05-26 15:01:46 -06003110 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003111 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 -06003112 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003113 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003114 }
Dave Houlton48989f32017-05-26 15:01:46 -06003115
Dave Houlton33c2d252017-06-09 17:08:32 -06003116 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3117 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 -06003118 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Dave Houlton33c2d252017-06-09 17:08:32 -06003119 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003120 "image format %s.",
3121 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003122 }
3123
3124 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3125 skip |= log_msg(
3126 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003127 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003128 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
3129 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003130 }
3131
Dave Houlton48989f32017-05-26 15:01:46 -06003132 // Validate source image offsets
3133 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003134 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003135 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
3136 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 -06003137 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
Dave Houlton48989f32017-05-26 15:01:46 -06003138 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003139 "of (%1d, %1d). These must be (0, 1).",
3140 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003141 }
3142 }
3143
Dave Houlton33c2d252017-06-09 17:08:32 -06003144 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003145 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3146 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 -06003147 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Dave Houlton48989f32017-05-26 15:01:46 -06003148 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003149 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3150 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003151 }
3152 }
3153
Dave Houlton33c2d252017-06-09 17:08:32 -06003154 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003155 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3156 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003157 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003158 skip |=
3159 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-srcOffset-00243",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003161 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3162 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003163 }
3164 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3165 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003166 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003167 skip |= log_msg(
3168 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003169 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003170 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
3171 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003172 }
3173 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3174 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003175 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003176 skip |=
3177 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003178 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003179 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3180 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003181 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003182 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003183 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 -06003184 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003185 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003186 }
Dave Houlton48989f32017-05-26 15:01:46 -06003187
3188 // Validate dest image offsets
3189 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003190 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003191 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
3192 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 -06003193 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
Dave Houlton48989f32017-05-26 15:01:46 -06003194 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003195 "(%1d, %1d). These must be (0, 1).",
3196 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003197 }
3198 }
3199
Dave Houlton33c2d252017-06-09 17:08:32 -06003200 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003201 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3202 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 -06003203 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Dave Houlton48989f32017-05-26 15:01:46 -06003204 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003205 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3206 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003207 }
3208 }
3209
Dave Houlton33c2d252017-06-09 17:08:32 -06003210 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003211 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3212 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003213 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003214 skip |=
3215 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-dstOffset-00248",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003217 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
3218 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003219 }
3220 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3221 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003222 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003223 skip |= log_msg(
3224 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003225 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003226 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
3227 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003228 }
3229 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3230 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003231 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003232 skip |=
3233 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 -06003234 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003235 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
3236 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003237 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003238 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003239 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 -06003240 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003241 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003242 }
3243
Dave Houlton33c2d252017-06-09 17:08:32 -06003244 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3245 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3246 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
3247 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003248 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
Dave Houlton33c2d252017-06-09 17:08:32 -06003249 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003250 "layerCount other than 1.",
3251 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003252 }
3253 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003254 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003255 } else {
3256 assert(0);
3257 }
3258 return skip;
3259}
3260
Tobin Ehlis58c884f2017-02-08 12:15:27 -07003261void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003262 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
3263 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
3264 // Make sure that all image slices are updated to correct layout
3265 for (uint32_t i = 0; i < region_count; ++i) {
3266 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
3267 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
3268 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003269 // Update bindings between images and cmd buffer
3270 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3271 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003272}
3273
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003274// 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 -07003275bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003276 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3277 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003278 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07003279 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003280 for (auto cb_image_data : pCB->imageLayoutMap) {
3281 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003282
Dave Houltonb3f4b282018-02-22 16:25:16 -07003283 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3284 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003285 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3286 // TODO: Set memory invalid which is in mem_tracker currently
3287 } else if (imageLayout != cb_image_data.second.initialLayout) {
3288 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003289 skip |= log_msg(
3290 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003291 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003292 "Submitted command buffer expects image 0x%" PRIx64
3293 " (subresource: aspectMask 0x%X array layer %u, mip level %u) to be in layout %s--instead, image 0x%" PRIx64
3294 "'s current layout is %s.",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003295 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
3296 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003297 string_VkImageLayout(cb_image_data.second.initialLayout), HandleToUint64(cb_image_data.first.image),
3298 string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003299 } else {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003300 skip |=
3301 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3302 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3303 "Submitted command buffer expects image 0x%" PRIx64 " to be in layout %s--instead, image 0x%" PRIx64
3304 "'s current layout is %s.",
3305 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(cb_image_data.second.initialLayout),
3306 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003307 }
3308 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003309 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003310 }
3311 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003312 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003313}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003314
Tony Barbourdf013b92017-01-25 12:53:48 -07003315void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
3316 for (auto cb_image_data : pCB->imageLayoutMap) {
3317 VkImageLayout imageLayout;
3318 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3319 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3320 }
3321}
3322
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003323// Print readable FlagBits in FlagMask
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003324static std::string StringVkAccessFlags(VkAccessFlags accessMask) {
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003325 std::string result;
3326 std::string separator;
3327
3328 if (accessMask == 0) {
3329 result = "[None]";
3330 } else {
3331 result = "[";
3332 for (auto i = 0; i < 32; i++) {
3333 if (accessMask & (1 << i)) {
3334 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
3335 separator = " | ";
3336 }
3337 }
3338 result = result + "]";
3339 }
3340 return result;
3341}
3342
Dave Houlton12befb92018-06-26 17:16:46 -06003343#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 -06003344 // validation ToBeRemoved (disabled 6/18)
Dave Houlton12befb92018-06-26 17:16:46 -06003345
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003346// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
3347// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003348// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003349static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
3350 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
3351 const char *type) {
3352 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3353 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003354
3355 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
3356 if (accessMask & ~(required_bit | optional_bits)) {
3357 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003358 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 -06003359 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003360 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003361 StringVkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003362 }
3363 } else {
3364 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003365 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 -06003366 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003367 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
3368 "has previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003369 type, accessMask, StringVkAccessFlags(accessMask).c_str(), optional_bits,
3370 StringVkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003371 } else {
3372 std::string opt_bits;
3373 if (optional_bits != 0) {
3374 std::stringstream ss;
3375 ss << optional_bits;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003376 opt_bits = "and may have optional bits " + ss.str() + ' ' + StringVkAccessFlags(optional_bits);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003377 }
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 have required access bit %d %s %s when layout is %s, unless the app has "
3381 "previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003382 type, accessMask, StringVkAccessFlags(accessMask).c_str(), required_bit,
3383 StringVkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003384 }
3385 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003386 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003387}
Dave Houlton12befb92018-06-26 17:16:46 -06003388#endif
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003389
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003390// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003391// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3392// layout attachments don't have CLEAR as their loadOp.
Tobias Hectorbbb12282018-10-22 15:17:59 +01003393bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3394 const VkImageLayout first_layout, const uint32_t attachment,
3395 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003396 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003397 const char *vuid;
3398 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3399
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003400 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3401 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003402 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3403 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3404 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003405 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003406 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3407 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3408 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3409 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3410 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3411 skip |=
3412 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3413 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003414 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003415 }
3416 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003417 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3418 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003419 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003420 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003421 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 -06003422 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003423 }
3424 }
3425
3426 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3427 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003428 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003429 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003430 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 -06003431 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003432 }
3433 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003434 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003435}
3436
Tobias Hectorbbb12282018-10-22 15:17:59 +01003437bool ValidateLayouts(const core_validation::layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3438 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003439 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003440 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003441 const char *vuid;
3442 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3443 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003444
Jason Ekstranda1906302017-12-03 20:16:32 -08003445 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3446 VkFormat format = pCreateInfo->pAttachments[i].format;
3447 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3448 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3449 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003450 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 -06003451 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003452 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3453 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3454 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3455 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003456 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003457 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003458 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 -06003459 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003460 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3461 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3462 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3463 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003464 }
3465 }
3466 }
3467
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003468 // Track when we're observing the first use of an attachment
3469 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3470 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003471 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003472
3473 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3474 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3475 auto attach_index = subpass.pInputAttachments[j].attachment;
3476 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003477 switch (subpass.pInputAttachments[j].layout) {
3478 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3479 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3480 // These are ideal.
3481 break;
3482
3483 case VK_IMAGE_LAYOUT_GENERAL:
3484 // May not be optimal. TODO: reconsider this warning based on other constraints.
3485 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003486 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003487 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3488 break;
3489
Tobias Hectorbbb12282018-10-22 15:17:59 +01003490 case VK_IMAGE_LAYOUT_UNDEFINED:
3491 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3492 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3493 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3494 "Layout for input attachment reference %u in subpass %u is %s but must be "
3495 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3496 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3497 break;
3498
Graeme Leese668a9862018-10-08 10:40:02 +01003499 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3500 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3501 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3502 break;
3503 } else {
3504 // Intentionally fall through to generic error message
3505 }
3506 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003507
Cort Stratton7547f772017-05-04 15:18:52 -07003508 default:
3509 // No other layouts are acceptable
3510 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 -06003511 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003512 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3513 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3514 }
3515
Cort Stratton7547f772017-05-04 15:18:52 -07003516 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003517 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3518 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003519
3520 bool used_as_depth =
3521 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3522 bool used_as_color = false;
3523 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3524 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3525 }
3526 if (!used_as_depth && !used_as_color &&
3527 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003528 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3529 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3530 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3531 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003532 }
3533 }
3534 attach_first_use[attach_index] = false;
3535 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003536
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003537 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3538 auto attach_index = subpass.pColorAttachments[j].attachment;
3539 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3540
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003541 // TODO: Need a way to validate shared presentable images here, currently just allowing
3542 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3543 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003544 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003545 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003546 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003547 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3548 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003549 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003550
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003551 case VK_IMAGE_LAYOUT_GENERAL:
3552 // May not be optimal; TODO: reconsider this warning based on other constraints?
3553 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003554 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003555 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3556 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003557
Tobias Hectorbbb12282018-10-22 15:17:59 +01003558 case VK_IMAGE_LAYOUT_UNDEFINED:
3559 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3560 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3561 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3562 "Layout for color attachment reference %u in subpass %u is %s but should be "
3563 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3564 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3565 break;
3566
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003567 default:
3568 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 -06003569 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003570 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3571 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003572 }
3573
Tobias Hectorbbb12282018-10-22 15:17:59 +01003574 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3575 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
3576 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3577 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3578 "Layout for color attachment reference %u in subpass %u is %s but should be "
3579 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3580 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3581 }
3582
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003583 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003584 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3585 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003586 }
3587 attach_first_use[attach_index] = false;
3588 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003589
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003590 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3591 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003592 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3593 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3594 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003595 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003596
Dave Houltona9df0ce2018-02-07 10:51:23 -07003597 case VK_IMAGE_LAYOUT_GENERAL:
3598 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3599 // doing a bunch of transitions.
3600 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003601 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003602 "GENERAL layout for depth attachment may not give optimal performance.");
3603 break;
3604
Tobias Hectorbbb12282018-10-22 15:17:59 +01003605 case VK_IMAGE_LAYOUT_UNDEFINED:
3606 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3607 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3608 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3609 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3610 "layout or GENERAL.",
3611 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3612 break;
3613
Dave Houltona9df0ce2018-02-07 10:51:23 -07003614 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3615 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3616 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3617 break;
3618 } else {
3619 // Intentionally fall through to generic error message
3620 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003621 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003622
Dave Houltona9df0ce2018-02-07 10:51:23 -07003623 default:
3624 // No other layouts are acceptable
3625 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 -06003626 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003627 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3628 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3629 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003630 }
3631
3632 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3633 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003634 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3635 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003636 }
3637 attach_first_use[attach_index] = false;
3638 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003639 }
3640 return skip;
3641}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003642
3643// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003644bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3645 VkDeviceSize offset, VkDeviceSize end_offset) {
3646 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3647 bool skip = false;
3648 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3649 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003650 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3651 for (auto image_handle : mem_info->bound_images) {
3652 auto img_it = mem_info->bound_ranges.find(image_handle);
3653 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003654 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003655 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003656 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003657 for (auto layout : layouts) {
3658 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003659 skip |=
3660 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 -06003661 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003662 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3663 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003664 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003665 }
3666 }
3667 }
3668 }
3669 }
3670 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003671 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003672}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003673
3674// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3675// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003676static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3677 VulkanObjectType obj_type, std::string msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003678 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003679
3680 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003681 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003682 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003683 if (strict) {
3684 correct_usage = ((actual & desired) == desired);
3685 } else {
3686 correct_usage = ((actual & desired) != 0);
3687 }
3688 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003689 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003690 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003691 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003692 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 -06003693 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003694 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3695 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003696 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003697 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003698 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 -06003699 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3700 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003701 }
3702 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003703 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003704}
3705
3706// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3707// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003708bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003709 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003710 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3711 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003712}
3713
Cort Stratton186b1a22018-05-01 20:18:06 -04003714bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Dave Houltone0969282018-05-23 15:54:31 -06003715 char const *func_name, const std::string &linear_vuid, const std::string &optimal_vuid) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003716 VkFormatProperties format_properties = GetPDFormatProperties(dev_data, image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003717 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3718 bool skip = false;
3719 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3720 if ((format_properties.linearTilingFeatures & desired) != desired) {
3721 skip |=
3722 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3723 HandleToUint64(image_state->image), linear_vuid,
3724 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3725 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3726 }
3727 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3728 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3729 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3730 HandleToUint64(image_state->image), optimal_vuid,
3731 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3732 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3733 HandleToUint64(image_state->image));
3734 }
3735 }
3736 return skip;
3737}
3738
Cort Strattond619a302018-05-17 19:46:32 -07003739bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3740 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3741 uint32_t i) {
3742 bool skip = false;
3743 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3744 // layerCount must not be zero
3745 if (subresource_layers->layerCount == 0) {
3746 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3747 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3748 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3749 }
3750 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3751 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3752 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3753 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3754 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3755 }
3756 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3757 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3758 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
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-aspectMask-00167",
3761 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3762 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3763 func_name, i, member);
3764 }
3765 return skip;
3766}
3767
Mark Lobodzinski96210742017-02-09 10:33:46 -07003768// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3769// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003770bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003771 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003772 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3773 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003774}
3775
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003776bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3777 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3778 bool skip = false;
3779 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3780
3781 const VkDeviceSize &range = pCreateInfo->range;
3782 if (range != VK_WHOLE_SIZE) {
3783 // Range must be greater than 0
3784 if (range <= 0) {
3785 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3786 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3787 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3788 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3789 range);
3790 }
3791 // Range must be a multiple of the element size of format
3792 const size_t format_size = FormatSize(pCreateInfo->format);
3793 if (range % format_size != 0) {
3794 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3795 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3796 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3797 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3798 "(" PRINTF_SIZE_T_SPECIFIER ").",
3799 range, format_size);
3800 }
3801 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3802 if (range / format_size > device_limits->maxTexelBufferElements) {
3803 skip |=
3804 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3805 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3806 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3807 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3808 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3809 range, format_size, device_limits->maxTexelBufferElements);
3810 }
3811 // The sum of range and offset must be less than or equal to the size of buffer
3812 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3813 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3814 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3815 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3816 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3817 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3818 range, pCreateInfo->offset, buffer_state->createInfo.size);
3819 }
3820 }
3821 return skip;
3822}
3823
Shannon McPherson265383a2018-06-21 15:37:52 -06003824bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3825 const VkBufferViewCreateInfo *pCreateInfo) {
3826 bool skip = false;
3827 const debug_report_data *report_data = GetReportData(device_data);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003828 const VkFormatProperties format_properties = GetPDFormatProperties(device_data, pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003829 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3830 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3831 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3832 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3833 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3834 "be supported for uniform texel buffers");
3835 }
3836 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3837 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3838 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3839 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3840 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3841 "be supported for storage texel buffers");
3842 }
3843 return skip;
3844}
3845
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003846bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003847 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003848 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3849
Dave Houltond8ed0212018-05-16 17:18:24 -06003850 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003851
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003852 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003853 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 -06003854 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003855 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003856 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003857 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003858
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003859 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3860 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003861 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06003862 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003863 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003864 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003865 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003866
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003867 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3868 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003869 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 -06003870 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003871 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003872 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003873 }
Jeff Bolz87697532019-01-11 22:54:00 -06003874
3875 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3876 if (chained_devaddr_struct) {
3877 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3878 chained_devaddr_struct->deviceAddress != 0) {
3879 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3880 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3881 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3882 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3883 }
3884 }
3885
3886 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3887 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddressCaptureReplay) {
3888 skip |= log_msg(
3889 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3890 "VUID-VkBufferCreateInfo-flags-02605",
3891 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3892 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3893 }
3894
3895 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
3896 !GetEnabledFeatures(device_data)->buffer_address.bufferDeviceAddress) {
3897 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3898 "VUID-VkBufferCreateInfo-usage-02606",
3899 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3900 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3901 }
3902
Mark Lobodzinski96210742017-02-09 10:33:46 -07003903 return skip;
3904}
3905
3906void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3907 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3908 GetBufferMap(device_data)
3909 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3910}
3911
Shannon McPhersona84241a2018-06-18 15:34:46 -06003912bool PreCallValidateCreateBufferView(const layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003913 bool skip = false;
Shannon McPherson883f6092018-06-14 13:15:25 -06003914 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003915 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003916 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3917 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003918 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3919 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003920 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3921 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003922 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3923 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3924 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3925 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003926
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003927 // Buffer view offset must be less than the size of buffer
3928 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3929 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3930 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3931 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3932 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3933 pCreateInfo->offset, buffer_state->createInfo.size);
3934 }
3935
Mark Lobodzinski1cf55ac2019-01-14 14:33:43 -07003936 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties(device_data)->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06003937 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3938 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3939 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3940 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3941 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3942 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3943 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3944 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003945
3946 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003947
3948 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003949 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003950 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003951}
3952
3953void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3954 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3955}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003956
3957// For the given format verify that the aspect masks make sense
Tobias Hectorbbb12282018-10-22 15:17:59 +01003958bool ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3959 const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003960 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3961 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003962 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3963 if (image != VK_NULL_HANDLE) {
3964 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3965 }
3966
Dave Houlton1d2022c2017-03-29 11:43:58 -06003967 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003968 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003969 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003970 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003971 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003972 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003973 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003974 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003975 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003976 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003977 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003978 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003979 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3980 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003981 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003982 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003983 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003984 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3985 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003986 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003987 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003988 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003989 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003990 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003991 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003992 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003993 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003994 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003995 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003996 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003997 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003998 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003999 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004000 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004001 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004002 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004003 } else if (FormatIsMultiplane(format)) {
4004 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4005 if (3 == FormatPlaneCount(format)) {
4006 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4007 }
4008 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004009 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004010 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4011 "set, where n = [0, 1, 2].",
4012 func_name);
4013 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004014 }
4015 return skip;
4016}
4017
Petr Krausffa94af2017-08-08 21:46:02 +02004018struct SubresourceRangeErrorCodes {
Dave Houltond8ed0212018-05-16 17:18:24 -06004019 std::string base_mip_err, mip_count_err, base_layer_err, layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02004020};
4021
4022bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
4023 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
4024 const char *image_layer_count_var_name, const uint64_t image_handle,
4025 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004026 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4027 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004028
4029 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004030 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004031 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 -06004032 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004033 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004034 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4035 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004036 }
Petr Kraus4d718682017-05-18 03:38:41 +02004037
Petr Krausffa94af2017-08-08 21:46:02 +02004038 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4039 if (subresourceRange.levelCount == 0) {
4040 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 -06004041 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004042 } else {
4043 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004044
Petr Krausffa94af2017-08-08 21:46:02 +02004045 if (necessary_mip_count > image_mip_count) {
4046 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 -06004047 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004048 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004049 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004050 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004051 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004052 }
Petr Kraus4d718682017-05-18 03:38:41 +02004053 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004054 }
Petr Kraus4d718682017-05-18 03:38:41 +02004055
4056 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004057 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004058 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 -06004059 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004060 "%s: %s.baseArrayLayer (= %" PRIu32
4061 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4062 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004063 }
Petr Kraus4d718682017-05-18 03:38:41 +02004064
Petr Krausffa94af2017-08-08 21:46:02 +02004065 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4066 if (subresourceRange.layerCount == 0) {
4067 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 -06004068 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004069 } else {
4070 const uint64_t necessary_layer_count =
4071 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004072
Petr Krausffa94af2017-08-08 21:46:02 +02004073 if (necessary_layer_count > image_layer_count) {
4074 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 -06004075 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004076 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004077 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004078 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004079 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004080 }
Petr Kraus4d718682017-05-18 03:38:41 +02004081 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004082 }
Petr Kraus4d718682017-05-18 03:38:41 +02004083
Mark Lobodzinski602de982017-02-09 11:01:33 -07004084 return skip;
4085}
4086
Petr Krausffa94af2017-08-08 21:46:02 +02004087bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4088 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
4089 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
4090 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4091 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4092 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4093
4094 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4095 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4096
4097 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004098 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4099 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4100 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4101 : "VUID-VkImageViewCreateInfo-image-01482")
4102 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4103 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4104 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4105 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4106 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004107
4108 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4109 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4110 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4111}
4112
4113bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4114 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4115 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004116 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4117 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4118 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4119 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004120
4121 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4122 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4123 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4124}
4125
4126bool ValidateCmdClearDepthSubresourceRange(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-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4130 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4131 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4132 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004133
4134 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4135 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4136 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4137}
4138
4139bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4140 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4141 const char *param_name) {
4142 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004143 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4144 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4145 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4146 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004147
4148 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4149 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4150 subresourceRangeErrorCodes);
4151}
4152
Mark Lobodzinski602de982017-02-09 11:01:33 -07004153bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
4154 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4155 bool skip = false;
4156 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
4157 if (image_state) {
4158 skip |= ValidateImageUsageFlags(
4159 device_data, image_state,
4160 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004161 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4162 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004163 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004164 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004165 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004166 skip |=
4167 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004168 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004169 skip |= ValidateCreateImageViewSubresourceRange(
4170 device_data, image_state,
4171 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4172 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004173
4174 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4175 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004176 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4177 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004178 VkFormat view_format = create_info->format;
4179 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004180 VkImageType image_type = image_state->createInfo.imageType;
4181 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004182
Dave Houltonbd2e2622018-04-10 16:41:14 -06004183 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
4184 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
4185 if (chained_ivuci_struct) {
4186 if (chained_ivuci_struct->usage & ~image_usage) {
4187 std::stringstream ss;
4188 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004189 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004190 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004191 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4192 HandleToUint64(create_info->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
4193 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004194 }
4195
4196 image_usage = chained_ivuci_struct->usage;
4197 }
4198
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004199 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4200 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004201 if (FormatIsMultiplane(image_format)) {
4202 // View format must match the multiplane compatible format
4203 uint32_t plane = 3; // invalid
4204 switch (aspect_mask) {
4205 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4206 plane = 0;
4207 break;
4208 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4209 plane = 1;
4210 break;
4211 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4212 plane = 2;
4213 break;
4214 default:
4215 break;
4216 }
4217
4218 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4219 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004220 std::stringstream ss;
4221 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004222 << " is not compatible with plane " << plane << " of underlying image format "
4223 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004224 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4225 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
4226 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004227 }
4228 } else {
4229 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
4230 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4231 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4232 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4233 std::stringstream ss;
4234 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
4235 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
4236 << ") format " << string_VkFormat(image_format)
4237 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4238 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
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,
4240 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
4241 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004242 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004243 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004244 }
4245 } else {
4246 // Format MUST be IDENTICAL to the format the image was created with
4247 if (image_format != view_format) {
4248 std::stringstream ss;
4249 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02004250 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004251 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004252 skip |=
4253 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4254 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004255 }
4256 }
4257
4258 // Validate correct image aspect bits for desired formats and format consistency
4259 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004260
4261 switch (image_type) {
4262 case VK_IMAGE_TYPE_1D:
4263 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004264 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4265 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004266 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4267 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004268 }
4269 break;
4270 case VK_IMAGE_TYPE_2D:
4271 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4272 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4273 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004274 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4275 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004276 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4277 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004278 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_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,
4280 HandleToUint64(create_info->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 }
4285 break;
4286 case VK_IMAGE_TYPE_3D:
4287 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4288 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4289 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4290 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004291 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004292 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4293 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004294 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4295 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004296 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4297 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004298 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004299 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4300 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004301 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4302 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004303 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4304 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004305 }
4306 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004307 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4308 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
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 }
4312 }
4313 } else {
4314 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004315 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4316 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004317 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4318 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004319 }
4320 }
4321 break;
4322 default:
4323 break;
4324 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004325
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004326 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
4327 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
4328 skip |= ValidateCreateImageViewANDROID(device_data, create_info);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004329 }
4330
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004331 VkFormatProperties format_properties = GetPDFormatProperties(device_data, view_format);
4332 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4333 : format_properties.optimalTilingFeatures;
4334
4335 if (tiling_features == 0) {
4336 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4337 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-None-02273",
4338 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4339 "physical device.",
4340 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4341 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4342 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4343 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02274",
4344 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4345 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4346 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4347 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4348 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4349 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02275",
4350 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4351 "VK_IMAGE_USAGE_STORAGE_BIT.",
4352 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4353 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4354 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4356 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02276",
4357 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4358 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4359 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4360 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4361 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4362 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4363 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02277",
4364 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4365 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4366 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004367 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004368
Jeff Bolz9af91c52018-09-01 21:53:57 -05004369 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4370 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4371 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4372 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02086",
4373 "vkCreateImageView() If image was created with usage containing "
4374 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4375 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4376 }
4377 if (view_format != VK_FORMAT_R8_UINT) {
4378 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4379 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02087",
4380 "vkCreateImageView() If image was created with usage containing "
4381 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4382 }
4383 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004384 }
4385 return skip;
4386}
4387
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004388void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
4389 auto image_view_map = GetImageViewMap(device_data);
4390 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
4391
4392 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004393 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004394 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4395 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004396}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004397
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004398bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4399 BUFFER_STATE *dst_buffer_state) {
4400 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004401 skip |=
4402 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4403 skip |=
4404 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004405 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004406 skip |=
4407 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4408 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4409 skip |=
4410 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4411 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004412 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004413 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4414 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004415 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004416 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004417 return skip;
4418}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004419
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004420void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4421 BUFFER_STATE *dst_buffer_state) {
4422 // Update bindings between buffers and cmd buffer
4423 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4424 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004425}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004426
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004427static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004428 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4429 bool skip = false;
4430 auto buffer_state = GetBufferState(device_data, buffer);
4431 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004432 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 -06004433 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01004434 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004435 } else {
4436 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004437 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 -06004438 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004439 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004440 }
4441 }
4442 return skip;
4443}
4444
4445bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
4446 VK_OBJECT *obj_struct) {
4447 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004448 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004449 if (GetDisables(device_data)->destroy_image_view) return false;
4450 bool skip = false;
4451 if (*image_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004452 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView",
4453 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004454 }
4455 return skip;
4456}
4457
John Zulauffca05c12018-04-26 16:30:39 -06004458void PreCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
4459 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004460 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004461 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004462 (*GetImageViewMap(device_data)).erase(image_view);
4463}
4464
4465bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
4466 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02004467 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004468 if (GetDisables(device_data)->destroy_buffer) return false;
4469 bool skip = false;
4470 if (*buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004471 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004472 }
4473 return skip;
4474}
4475
John Zulauffca05c12018-04-26 16:30:39 -06004476void PreCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004477 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004478 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4479 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4480 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004481 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004482 }
4483 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004484 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004485 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004486 GetBufferMap(device_data)->erase(buffer_state->buffer);
4487}
4488
4489bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
4490 VK_OBJECT *obj_struct) {
4491 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004492 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004493 if (GetDisables(device_data)->destroy_buffer_view) return false;
4494 bool skip = false;
4495 if (*buffer_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004496 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView",
4497 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004498 }
4499 return skip;
4500}
4501
John Zulauffca05c12018-04-26 16:30:39 -06004502void PreCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
4503 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004504 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004505 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004506 GetBufferViewMap(device_data)->erase(buffer_view);
4507}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004508
4509bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
4510 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004511 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004512 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004513 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4514 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004515 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4516 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004517 skip |=
4518 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4519 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004520 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004521 return skip;
4522}
4523
4524void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004525 // Update bindings between buffer and cmd buffer
4526 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004527}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004528
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004529bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4530 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004531 bool skip = false;
4532
4533 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004534 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4535 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004536 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 -06004537 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004538 "%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 -06004539 "and 1, respectively.",
4540 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004541 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004542 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004543
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004544 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4545 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004546 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 -06004547 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004548 "%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 -06004549 "must be 0 and 1, respectively.",
4550 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004551 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004552 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004553
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004554 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4555 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004556 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 -06004557 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004558 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4559 "For 3D images these must be 0 and 1, respectively.",
4560 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004561 }
4562 }
4563
4564 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
4565 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06004566 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06004567 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004568 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 -06004569 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004570 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004571 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
4572 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004573 }
4574
4575 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004576 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004577 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-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004579 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4580 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004581 }
4582
4583 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4584 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004585 skip |=
4586 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004587 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004588 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4589 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004590 }
4591
4592 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4593 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4594 skip |= log_msg(
4595 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004596 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004597 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4598 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004599 }
4600
4601 // subresource aspectMask must have exactly 1 bit set
4602 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4603 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4604 if (aspect_mask_bits.count() != 1) {
4605 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 -06004606 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004607 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004608 }
4609
4610 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004611 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004612 skip |= log_msg(
4613 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004614 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004615 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4616 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004617 }
4618
4619 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004620 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004621 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004622
4623 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004624 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004625 skip |= log_msg(
4626 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-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004628 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4629 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004630 }
4631
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004632 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004633 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004634 skip |= log_msg(
4635 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004636 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004637 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4638 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004639 }
4640
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004641 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004642 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4643 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4644 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004645 skip |=
4646 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004647 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004648 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4649 "width & height (%d, %d)..",
4650 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004651 }
4652
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004653 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004654 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
4655 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004656 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 -06004657 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004658 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4659 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
4660 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004661 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004662
4663 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004664 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004665 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004666 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4667 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 -06004668 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004669 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004670 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004671 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004672 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004673 }
4674
4675 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004676 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004677 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4678 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 -06004679 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004680 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004681 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004682 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004683 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004684 }
4685
4686 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004687 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004688 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4689 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 -06004690 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004691 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004692 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004693 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004694 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004695 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004696 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004697 }
4698
4699 return skip;
4700}
4701
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004702static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Dave Houltond8ed0212018-05-16 17:18:24 -06004703 const VkBufferImageCopy *pRegions, const char *func_name, std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004704 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004705 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004706
4707 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004708 VkExtent3D extent = pRegions[i].imageExtent;
4709 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004710
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004711 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4712 {
Dave Houlton51653902018-06-22 17:32:13 -06004713 skip |=
4714 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4715 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4716 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004717 }
4718
4719 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4720
4721 // 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 -06004722 if (FormatIsCompressed(image_info->format)) {
4723 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004724 if (image_extent.width % block_extent.width) {
4725 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4726 }
4727 if (image_extent.height % block_extent.height) {
4728 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4729 }
4730 if (image_extent.depth % block_extent.depth) {
4731 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4732 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004733 }
4734
Dave Houltonfc1a4052017-04-27 14:32:45 -06004735 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004736 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 -06004737 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004738 }
4739 }
4740
4741 return skip;
4742}
4743
Chris Forbese8ba09a2017-06-01 17:39:02 -07004744static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004745 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06004746 std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004747 bool skip = false;
4748
4749 VkDeviceSize buffer_size = buff_state->createInfo.size;
4750
4751 for (uint32_t i = 0; i < regionCount; i++) {
4752 VkExtent3D copy_extent = pRegions[i].imageExtent;
4753
4754 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4755 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004756 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004757
Dave Houltonf3229d52017-02-21 15:59:08 -07004758 // Handle special buffer packing rules for specific depth/stencil formats
4759 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004760 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004761 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4762 switch (image_state->createInfo.format) {
4763 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004764 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004765 break;
4766 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004767 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004768 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004769 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004770 case VK_FORMAT_D24_UNORM_S8_UINT:
4771 unit_size = 4;
4772 break;
4773 default:
4774 break;
4775 }
4776 }
4777
Tom Cooperb2550c72018-10-15 13:08:41 +01004778 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004779 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06004780 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004781 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4782 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4783
4784 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4785 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4786 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004787 }
4788
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004789 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4790 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4791 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004792 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004793 } else {
4794 // Calculate buffer offset of final copied byte, + 1.
4795 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4796 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4797 max_buffer_offset *= unit_size; // convert to bytes
4798 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004799
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004800 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004801 skip |=
4802 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4803 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004804 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004805 }
4806 }
4807
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004808 return skip;
4809}
4810
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004811bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004812 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004813 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004814 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4815 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4816
4817 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004818 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004819
4820 // Command pool must support graphics, compute, or transfer operations
4821 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4822
4823 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4824 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4825 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 -06004826 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004827 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004828 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004829 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004830 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004831 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004832 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004833 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004834
4835 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004836 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4837 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4838 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4839 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4840 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004841
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004842 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004843 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4844 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4845 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004846 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004847 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4848 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004849 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4850 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004851 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4852 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004853 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004854 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004855 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004856 const std::string src_invalid_layout_vuid =
4857 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4858 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4859 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004860 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004861 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4862 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004863 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004864 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4865 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004866 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004867 "vkCmdCopyImageToBuffer()",
4868 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004869 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4870 "vkCmdCopyImageToBuffer()", "imageSubresource",
4871 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4872 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4873 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4874 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004875 }
4876 return skip;
4877}
4878
4879void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004880 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4881 VkImageLayout src_image_layout) {
4882 // Make sure that all image slices are updated to correct layout
4883 for (uint32_t i = 0; i < region_count; ++i) {
4884 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4885 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004886 // Update bindings between buffer/image and cmd buffer
4887 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004888 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004889}
4890
4891bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004892 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004893 const VkBufferImageCopy *pRegions, const char *func_name) {
4894 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4895 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4896
4897 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004898 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004899
4900 // Command pool must support graphics, compute, or transfer operations
4901 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4902 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4903 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4904 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 -06004905 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004906 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004907 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004908 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004909 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004910 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004911 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004912 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004913 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004914 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4915 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4916 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4917 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4918 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004919 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004920 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4921 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4922 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4923 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4924 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004925 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4926 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004927 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4928 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004929 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004930 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004931 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004932 const std::string dst_invalid_layout_vuid =
4933 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4934 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4935 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004936 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004937 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4938 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004939 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004940 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4941 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004942 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004943 "vkCmdCopyBufferToImage()",
4944 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004945 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4946 "vkCmdCopyBufferToImage()", "imageSubresource",
4947 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4948 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4949 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4950 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004951 }
4952 return skip;
4953}
4954
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004955void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004956 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4957 VkImageLayout dst_image_layout) {
4958 // Make sure that all image slices are updated to correct layout
4959 for (uint32_t i = 0; i < region_count; ++i) {
4960 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4961 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004962 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004963 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004964}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004965
4966bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4967 const auto report_data = core_validation::GetReportData(device_data);
4968 bool skip = false;
4969 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4970
Dave Houlton1d960ff2018-01-19 12:17:05 -07004971 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004972 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4973 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4974 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004975 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 -06004976 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004977 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004978 }
4979
4980 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4981 if (!image_entry) {
4982 return skip;
4983 }
4984
Dave Houlton1d960ff2018-01-19 12:17:05 -07004985 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004986 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004987 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4988 "VUID-vkGetImageSubresourceLayout-image-00996",
4989 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004990 }
4991
Dave Houlton1d960ff2018-01-19 12:17:05 -07004992 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004993 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004994 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4995 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4996 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4997 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004998 }
4999
Dave Houlton1d960ff2018-01-19 12:17:05 -07005000 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005001 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005002 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5003 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5004 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5005 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005006 }
5007
Dave Houlton1d960ff2018-01-19 12:17:05 -07005008 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005009 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005010 if (FormatIsMultiplane(img_format)) {
5011 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Dave Houltond8ed0212018-05-16 17:18:24 -06005012 std::string vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005013 if (FormatPlaneCount(img_format) > 2u) {
5014 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005015 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005016 }
5017 if (sub_aspect != (sub_aspect & allowed_flags)) {
5018 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 -06005019 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005020 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005021 ") must be a single-plane specifier flag.",
5022 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005023 }
5024 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005025 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005026 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005027 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005028 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005029 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005030 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005031 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005032 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005033 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 -06005034 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005035 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005036 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005037 }
5038 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005039
5040 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
5041 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
5042 }
5043
Mike Weiblen672b58b2017-02-21 14:32:53 -07005044 return skip;
5045}