blob: 9cb58b6afebe2d08979c92988c584705cca64c28 [file] [log] [blame]
Dave Houlton51653902018-06-22 17:32:13 -06001/* Copyright (c) 2015-2018 The Khronos Group Inc.
2 * Copyright (c) 2015-2018 Valve Corporation
3 * Copyright (c) 2015-2018 LunarG, Inc.
4 * Copyright (C) 2015-2018 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 }
1284}
1285
1286bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
1287 bool skip = false;
1288 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1289 const VkExternalFormatANDROID *ext_format_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1290 if (ext_format_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001291 if (VK_FORMAT_UNDEFINED != create_info->format) {
1292 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1293 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1294 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1295 "format member is %s.",
1296 string_VkFormat(create_info->format));
1297 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001298
Dave Houltond9611312018-11-19 17:03:36 -07001299 // Chain must include a compatible ycbcr conversion
1300 bool conv_found = false;
1301 uint64_t external_format = 0;
1302 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1303 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
1305 auto fmap = GetYcbcrConversionFormatMap(device_data);
Dave Houltond9611312018-11-19 17:03:36 -07001306 if (fmap->find(conv_handle) != fmap->end()) {
1307 conv_found = true;
1308 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001309 }
Dave Houltond9611312018-11-19 17:03:36 -07001310 }
1311 if ((!conv_found) || (external_format != ext_format_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001312 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 -07001313 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1314 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1315 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1316 }
1317
1318 // Errors in create_info swizzles
1319 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1320 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1321 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1322 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1323 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1324 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1325 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1326 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001327 }
1328 }
Dave Houltond9611312018-11-19 17:03:36 -07001329
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001330 return skip;
1331}
1332
1333bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
1334 bool skip = false;
1335 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1336
1337 IMAGE_STATE *image_state = GetImageState(device_data, image);
1338 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1339 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1340 "VUID-vkGetImageSubresourceLayout-image-01895",
1341 "vkGetImageSubresourceLayout: Attempt to query layout from an image created with "
1342 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1343 "bound to memory.");
1344 }
1345 return skip;
1346}
1347
1348#else
1349
1350bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1351 const VkImageCreateInfo *create_info) {
1352 return false;
1353}
1354
1355void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
1356
1357bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
1358
1359bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
1360
1361#endif // VK_USE_PLATFORM_ANDROID_KHR
1362
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001363bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001364 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001365 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001366 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1367
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001368 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1369 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1370 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1371 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1372 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1373 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001374 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001375 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001376 }
1377
Dave Houlton130c0212018-01-29 13:39:56 -07001378 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001379 skip |= log_msg(
1380 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1381 "VUID-VkImageCreateInfo-flags-00949",
1382 "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 -07001383 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001384
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001385 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001386 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1387 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1388 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001389 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 +00001390 "VUID-VkImageCreateInfo-usage-00964",
1391 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1392 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001393 }
1394
1395 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001396 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 +00001397 "VUID-VkImageCreateInfo-usage-00965",
1398 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1399 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001400 }
1401
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001402 VkImageFormatProperties format_limits = {};
1403 VkResult res = GetPDImageFormatProperties(device_data, pCreateInfo, &format_limits);
1404 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1405 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1406 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1407 string_VkFormat(pCreateInfo->format));
1408 } else {
1409 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1410 const char *format_string = string_VkFormat(pCreateInfo->format);
1411 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1412 "VUID-VkImageCreateInfo-mipLevels-02255",
1413 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1414 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1415 }
Dave Houlton130c0212018-01-29 13:39:56 -07001416
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001417 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1418 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1419 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -07001420
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001421 // Round up to imageGranularity boundary
1422 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
1423 uint64_t ig_mask = imageGranularity - 1;
1424 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001425
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001426 if (total_size > format_limits.maxResourceSize) {
1427 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1428 kVUID_Core_Image_InvalidFormatLimitsViolation,
1429 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1430 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1431 total_size, format_limits.maxResourceSize);
1432 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001433
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001434 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1435 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1436 "VUID-VkImageCreateInfo-arrayLayers-02256",
1437 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1438 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1439 }
1440
1441 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1442 skip |=
1443 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1444 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001445 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001446 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001447 }
1448
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06001449 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) &&
1450 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001451 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 -06001452 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001453 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1454 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001455 }
1456
Lenny Komowb79f04a2017-09-18 17:07:00 -06001457 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1458 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1459 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1460 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1461 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001462 skip |=
1463 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1464 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1465 "format must be block, ETC or ASTC compressed, but is %s",
1466 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001467 }
1468 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1469 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001470 skip |=
1471 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1472 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1473 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001474 }
1475 }
1476 }
1477
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001478 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001479}
1480
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001481void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001482 IMAGE_LAYOUT_NODE image_state;
1483 image_state.layout = pCreateInfo->initialLayout;
1484 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001485 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
1486 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1487 RecordCreateImageANDROID(pCreateInfo, is_node);
1488 }
1489 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001490 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001491 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1492 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001493}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001494
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001495bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001496 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001497 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +02001498 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001499 if (disabled->destroy_image) return false;
1500 bool skip = false;
1501 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06001502 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001503 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001504 }
1505 return skip;
1506}
1507
John Zulauffca05c12018-04-26 16:30:39 -06001508void PreCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001509 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001510 // Clean up memory mapping, bindings and range references for image
1511 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001512 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001513 if (mem_info) {
1514 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1515 }
1516 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001517 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001518 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001519 // Remove image from imageMap
1520 core_validation::GetImageMap(device_data)->erase(image);
1521 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1522 core_validation::GetImageSubresourceMap(device_data);
1523
1524 const auto &sub_entry = imageSubresourceMap->find(image);
1525 if (sub_entry != imageSubresourceMap->end()) {
1526 for (const auto &pair : sub_entry->second) {
1527 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1528 }
1529 imageSubresourceMap->erase(sub_entry);
1530 }
1531}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001532
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001533bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001534 bool skip = false;
1535 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1536
1537 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1538 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1539 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 -06001540 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001541 }
1542
Dave Houlton1d2022c2017-03-29 11:43:58 -06001543 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001544 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1545 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 -06001546 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001547 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001548 char const str[] = "vkCmdClearColorImage called with compressed image.";
1549 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 -06001550 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001551 }
1552
1553 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1554 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
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-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001557 }
1558 return skip;
1559}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001560
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001561uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1562 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1563 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001564 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001565 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001566 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001567 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001568}
1569
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001570uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1571 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1572 uint32_t array_layer_count = range->layerCount;
1573 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1574 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001575 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001576 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001577}
1578
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001579bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001580 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1581 bool skip = false;
1582 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1583
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001584 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1585 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001586
1587 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1588 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001589 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1590 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001591 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 -06001592 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001593 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1594 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001595 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001596 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001597 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001598 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 -06001599 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001600 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1601 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001602
1603 } else {
1604 if (image_state->shared_presentable) {
1605 skip |= log_msg(
1606 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001607 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001608 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1609 string_VkImageLayout(dest_image_layout));
1610 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001611 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001612 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001613 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001614 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001615 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001616 } else {
1617 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1618 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001619 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 -06001620 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001621 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1622 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001623 }
1624 }
1625
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001626 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1627 uint32_t level = level_index + range.baseMipLevel;
1628 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1629 uint32_t layer = layer_index + range.baseArrayLayer;
1630 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001631 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001632 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001633 if (node.layout != dest_image_layout) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001634 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001635 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001636 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001637 } else {
1638 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1639 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001640 skip |=
1641 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1642 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1643 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001644 }
1645 }
1646 }
1647 }
1648
1649 return skip;
1650}
1651
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001652void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1653 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001654 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1655 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1656 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001657
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001658 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1659 uint32_t level = level_index + range.baseMipLevel;
1660 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1661 uint32_t layer = layer_index + range.baseArrayLayer;
1662 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001663 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001664 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1665 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 -07001666 }
1667 }
1668 }
1669}
1670
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001671bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001672 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1673 bool skip = false;
1674 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001675 auto cb_node = GetCBNode(dev_data, commandBuffer);
1676 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001677 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001678 skip |=
1679 ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001680 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001681 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001682 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001683 if (GetApiVersion(dev_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001684 skip |=
1685 ValidateImageFormatFeatureFlags(dev_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001686 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001687 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001688 skip |= InsideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001689 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001690 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001691 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001692 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001693 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001694 }
1695 }
1696 return skip;
1697}
1698
1699// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001700void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001701 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001702 auto cb_node = GetCBNode(dev_data, commandBuffer);
1703 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001704 if (cb_node && image_state) {
1705 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001706 for (uint32_t i = 0; i < rangeCount; ++i) {
1707 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1708 }
1709 }
1710}
1711
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001712bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1713 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001714 const VkImageSubresourceRange *pRanges) {
1715 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001716 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1717
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001718 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001719 auto cb_node = GetCBNode(device_data, commandBuffer);
1720 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001721 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001722 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1723 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001724 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001725 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001726 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001727 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1728 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001729 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1730 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001731 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001732 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001733 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001734 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001735 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001736 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001737 skip |=
1738 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001739 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001740 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1741 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001742 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001743 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1744 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001745 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 -06001746 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001747 }
1748 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001749 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001750 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001751 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 -06001752 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001753 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001754 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1755 char const str[] =
1756 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1757 "set.";
1758 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 -06001759 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001760 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001761 }
1762 return skip;
1763}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001764
1765// Returns true if [x, xoffset] and [y, yoffset] overlap
1766static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1767 bool result = false;
1768 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1769 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1770
1771 if (intersection_max > intersection_min) {
1772 result = true;
1773 }
1774 return result;
1775}
1776
Dave Houltonc991cc92018-03-06 11:08:51 -07001777// Returns true if source area of first copy region intersects dest area of second region
1778// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1779static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001780 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001781
Dave Houltonc991cc92018-03-06 11:08:51 -07001782 // Separate planes within a multiplane image cannot intersect
1783 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001784 return result;
1785 }
1786
Dave Houltonc991cc92018-03-06 11:08:51 -07001787 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1788 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1789 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001790 result = true;
1791 switch (type) {
1792 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001793 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001794 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001795 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001796 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001797 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001798 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001799 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001800 break;
1801 default:
1802 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1803 assert(false);
1804 }
1805 }
1806 return result;
1807}
1808
Dave Houltonfc1a4052017-04-27 14:32:45 -06001809// Returns non-zero if offset and extent exceed image extents
1810static const uint32_t x_bit = 1;
1811static const uint32_t y_bit = 2;
1812static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001813static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001814 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001815 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001816 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1817 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001818 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001819 }
1820 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1821 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001822 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001823 }
1824 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1825 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001826 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001827 }
1828 return result;
1829}
1830
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001831// Test if two VkExtent3D structs are equivalent
1832static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1833 bool result = true;
1834 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1835 (extent->depth != other_extent->depth)) {
1836 result = false;
1837 }
1838 return result;
1839}
1840
Dave Houltonee281a52017-12-08 13:51:02 -07001841// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1842// Destination image texel extents must be adjusted by block size for the dest validation checks
1843VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1844 VkExtent3D adjusted_extent = extent;
1845 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1846 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1847 adjusted_extent.width /= block_size.width;
1848 adjusted_extent.height /= block_size.height;
1849 adjusted_extent.depth /= block_size.depth;
1850 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1851 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1852 adjusted_extent.width *= block_size.width;
1853 adjusted_extent.height *= block_size.height;
1854 adjusted_extent.depth *= block_size.depth;
1855 }
1856 return adjusted_extent;
1857}
1858
Dave Houlton6f9059e2017-05-02 17:15:13 -06001859// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001860static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1861 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001862
1863 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001864 if (mip >= img->createInfo.mipLevels) {
1865 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001866 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001867
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001868 // 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 -06001869 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001870
1871 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1872 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001873 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001874 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1875 } else {
1876 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1877 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1878 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1879 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001880
Dave Houlton6f9059e2017-05-02 17:15:13 -06001881 // Image arrays have an effective z extent that isn't diminished by mip level
1882 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001883 extent.depth = img->createInfo.arrayLayers;
1884 }
1885
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001886 return extent;
1887}
1888
1889// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001890static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001891 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1892}
1893
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001894// Test if the extent argument has any dimensions set to 0.
1895static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1896 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1897}
1898
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001899// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1900static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1901 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1902 VkExtent3D granularity = {0, 0, 0};
1903 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1904 if (pPool) {
1905 granularity =
1906 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001907 if (FormatIsCompressed(img->createInfo.format)) {
1908 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001909 granularity.width *= block_size.width;
1910 granularity.height *= block_size.height;
1911 }
1912 }
1913 return granularity;
1914}
1915
1916// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1917static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1918 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001919 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1920 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001921 valid = false;
1922 }
1923 return valid;
1924}
1925
1926// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1927static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001928 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001929 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001930 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1931 bool skip = false;
1932 VkExtent3D offset_extent = {};
1933 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1934 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1935 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001936 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001937 // 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 -07001938 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001939 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 -04001940 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001941 "%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 "
1942 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001943 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001944 }
1945 } else {
1946 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1947 // integer multiples of the image transfer granularity.
1948 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001949 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 -04001950 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001951 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1952 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001953 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1954 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001955 }
1956 }
1957 return skip;
1958}
1959
1960// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1961static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1962 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001963 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001964 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001965 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1966 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001967 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001968 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1969 // subresource extent.
1970 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001971 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 -04001972 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001973 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1974 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1975 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1976 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001977 }
1978 } else {
1979 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1980 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1981 // subresource extent dimensions.
1982 VkExtent3D offset_extent_sum = {};
1983 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1984 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1985 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001986 bool x_ok = true;
1987 bool y_ok = true;
1988 bool z_ok = true;
1989 switch (image_type) {
1990 case VK_IMAGE_TYPE_3D:
1991 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1992 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001993 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001994 case VK_IMAGE_TYPE_2D:
1995 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1996 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001997 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001998 case VK_IMAGE_TYPE_1D:
1999 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2000 (subresource_extent->width == offset_extent_sum.width));
2001 break;
2002 default:
2003 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2004 assert(false);
2005 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002006 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002007 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 -04002008 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002009 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2010 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2011 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2012 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2013 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2014 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002015 }
2016 }
2017 return skip;
2018}
2019
Cort Strattonff1542a2018-05-27 10:49:28 -07002020bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
2021 const uint32_t i, const char *function, const char *member, const std::string &vuid) {
2022 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2023 bool skip = false;
2024 if (mip_level >= img->createInfo.mipLevels) {
2025 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2026 HandleToUint64(cb_node->commandBuffer), vuid,
2027 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
2028 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
2029 }
2030 return skip;
2031}
2032
2033bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2034 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
2035 const char *member, const std::string &vuid) {
2036 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2037 bool skip = false;
2038 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2039 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2040 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2041 HandleToUint64(cb_node->commandBuffer), vuid,
2042 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2043 "%u, but provided image %" PRIx64 " has %u array layers.",
2044 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
2045 }
2046 return skip;
2047}
2048
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002049// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002050bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2051 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Dave Houltone0969282018-05-23 15:54:31 -06002052 const uint32_t i, const char *function, const std::string &vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002053 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002054 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2055 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2056 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2057 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2058 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002059 return skip;
2060}
2061
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002062// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002063bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002064 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2065 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002066 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002067 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002068 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002069 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2070 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002071 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002072 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002073 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002074 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002075
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002076 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002077 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002078 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2079 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002080 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002081 const VkExtent3D dest_effective_extent =
2082 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002083 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002084 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002085 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002086 return skip;
2087}
2088
Dave Houlton6f9059e2017-05-02 17:15:13 -06002089// Validate contents of a VkImageCopy struct
2090bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
2091 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
2092 bool skip = false;
2093
2094 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002095 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002096
2097 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002098 const VkExtent3D src_copy_extent = region.extent;
2099 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002100 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2101
Dave Houlton6f9059e2017-05-02 17:15:13 -06002102 bool slice_override = false;
2103 uint32_t depth_slices = 0;
2104
2105 // Special case for copying between a 1D/2D array and a 3D image
2106 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2107 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002108 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002109 slice_override = (depth_slices != 1);
2110 } 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 -07002111 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002112 slice_override = (depth_slices != 1);
2113 }
2114
2115 // Do all checks on source image
2116 //
2117 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002118 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2119 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 -06002120 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002121 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002122 "be 0 and 1, respectively.",
2123 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002124 }
2125 }
2126
Dave Houlton533be9f2018-03-26 17:08:30 -06002127 // VUID-VkImageCopy-srcImage-01785
2128 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2129 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 -06002130 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002131 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002132 "these must be 0 and 1, respectively.",
2133 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002134 }
2135
Dave Houlton533be9f2018-03-26 17:08:30 -06002136 // VUID-VkImageCopy-srcImage-01787
2137 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2138 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 -06002139 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002140 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2141 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002142 }
2143
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002144 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002145 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002146 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002147 skip |=
2148 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002149 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002150 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002151 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2152 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002153 }
2154 }
2155 } else { // Pre maint 1
2156 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002157 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002158 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 -06002159 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002160 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2161 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002162 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2163 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002164 }
2165 }
2166 }
2167
Dave Houltonc991cc92018-03-06 11:08:51 -07002168 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2169 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
2170 if (FormatIsCompressed(src_state->createInfo.format) ||
2171 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002172 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002173 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002174 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2175 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2176 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002177 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002178 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 -07002179 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002180 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002181 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002182 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002183 }
2184
Dave Houlton94a00372017-12-14 15:08:47 -07002185 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002186 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2187 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002188 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002189 skip |=
2190 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002191 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002192 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002193 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002194 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002195 }
2196
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002197 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002198 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2199 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002200 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002201 skip |=
2202 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002203 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002204 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002205 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002206 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002207 }
2208
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002209 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002210 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2211 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002212 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002213 skip |=
2214 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002215 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002217 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002218 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002219 }
2220 } // Compressed
2221
2222 // Do all checks on dest image
2223 //
2224 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002225 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002226 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 -06002227 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002228 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002229 "these must be 0 and 1, respectively.",
2230 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002231 }
2232 }
2233
Dave Houlton533be9f2018-03-26 17:08:30 -06002234 // VUID-VkImageCopy-dstImage-01786
2235 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2236 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 -06002237 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002238 "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 -06002239 "and 1, respectively.",
2240 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002241 }
2242
2243 // VUID-VkImageCopy-dstImage-01788
2244 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2245 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 -06002246 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002247 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2248 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002249 }
2250
2251 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002252 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002253 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 -06002254 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002256 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2257 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002258 }
2259 }
2260 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002261 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002262 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002263 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002264 skip |=
2265 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002266 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002268 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2269 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 }
2271 }
2272 } else { // Pre maint 1
2273 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002274 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002275 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 -06002276 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002277 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2278 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002279 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2280 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002281 }
2282 }
2283 }
2284
Dave Houltonc991cc92018-03-06 11:08:51 -07002285 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2286 if (FormatIsCompressed(dst_state->createInfo.format) ||
2287 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002288 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002289
2290 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002291 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2292 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2293 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002294 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295 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 -07002296 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002297 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002298 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002299 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002300 }
2301
Dave Houlton94a00372017-12-14 15:08:47 -07002302 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002303 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2304 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002305 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002306 skip |=
2307 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002308 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002309 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002310 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002311 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002312 }
2313
Dave Houltonee281a52017-12-08 13:51:02 -07002314 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2315 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2316 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002317 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002318 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 -07002319 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002320 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2321 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002322 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002323 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002324 }
2325
Dave Houltonee281a52017-12-08 13:51:02 -07002326 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2327 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2328 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002329 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002330 skip |=
2331 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 width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002334 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002335 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 }
2337 } // Compressed
2338 }
2339 return skip;
2340}
2341
Dave Houltonc991cc92018-03-06 11:08:51 -07002342// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2343bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2344 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2345 bool skip = false;
2346 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2347
2348 // Neither image is multiplane
2349 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2350 // If neither image is multi-plane the aspectMask member of src and dst must match
2351 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2352 std::stringstream ss;
2353 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
2354 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2355 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 -06002356 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002357 }
2358 } else {
2359 // Source image multiplane checks
2360 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2361 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2362 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2363 std::stringstream ss;
2364 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2365 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 -06002366 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002367 }
2368 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2369 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2370 std::stringstream ss;
2371 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2372 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 -06002373 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002374 }
2375 // Single-plane to multi-plane
2376 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2377 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2378 std::stringstream ss;
2379 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2380 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 -06002381 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002382 }
2383
2384 // Dest image multiplane checks
2385 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2386 aspect = region.dstSubresource.aspectMask;
2387 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2388 std::stringstream ss;
2389 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2390 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 -06002391 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002392 }
2393 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2394 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2395 std::stringstream ss;
2396 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2397 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 -06002398 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002399 }
2400 // Multi-plane to single-plane
2401 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2402 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2403 std::stringstream ss;
2404 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2405 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 -06002406 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002407 }
2408 }
2409
2410 return skip;
2411}
2412
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002413bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002414 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2415 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002416 bool skip = false;
2417 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002418 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
2419
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002420 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2421
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002422 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002423 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002424
2425 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2426 VkExtent3D src_copy_extent = region.extent;
2427 VkExtent3D dst_copy_extent =
2428 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2429
Dave Houlton6f9059e2017-05-02 17:15:13 -06002430 bool slice_override = false;
2431 uint32_t depth_slices = 0;
2432
2433 // Special case for copying between a 1D/2D array and a 3D image
2434 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2435 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2436 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002437 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002438 slice_override = (depth_slices != 1);
2439 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2440 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002441 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002442 slice_override = (depth_slices != 1);
2443 }
2444
Cort Strattond619a302018-05-17 19:46:32 -07002445 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2446 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002447 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2448 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2449 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2450 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2451 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2452 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2453 "VUID-vkCmdCopyImage-srcSubresource-01698");
2454 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2455 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2456 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002457
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002458 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002459 // No chance of mismatch if we're overriding depth slice count
2460 if (!slice_override) {
2461 // The number of depth slices in srcSubresource and dstSubresource must match
2462 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2463 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002464 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2465 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002466 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002467 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2468 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 if (src_slices != dst_slices) {
2470 std::stringstream ss;
2471 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
2472 << "] do not match";
2473 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 -06002474 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002475 }
2476 }
2477 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002478 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002479 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002480 std::stringstream ss;
2481 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
2482 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002483 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 -06002484 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002485 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002486 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002487
Dave Houltonc991cc92018-03-06 11:08:51 -07002488 // Do multiplane-specific checks, if extension enabled
2489 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2490 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2491 }
2492
Dave Houltonf5217612018-02-02 16:18:52 -07002493 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2494 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2495 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2496 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
2497 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 -06002498 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002499 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002500 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002501
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002502 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002503 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002504 std::stringstream ss;
2505 ss << "vkCmdCopyImage: pRegion[" << i
2506 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2507 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 -06002508 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002509 }
2510
2511 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002512 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002513 std::stringstream ss;
2514 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2515 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 -06002516 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002517 }
2518
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002519 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2520 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2521 // 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 -07002522 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2523 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002524 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002525 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
2526 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2527 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2528 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002529 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 -06002530 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002531 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002532
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002533 // 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 -07002534 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2535 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002536 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002537 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2538 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2539 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2540 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002541 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002542 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002543 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002544 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002545
Dave Houltonfc1a4052017-04-27 14:32:45 -06002546 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002547 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2548 if (slice_override) src_copy_extent.depth = depth_slices;
2549 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002550 if (extent_check & x_bit) {
2551 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 -06002552 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002553 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002554 "width [%1d].",
2555 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002556 }
2557
2558 if (extent_check & y_bit) {
2559 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 -06002560 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002561 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002562 "height [%1d].",
2563 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002564 }
2565 if (extent_check & z_bit) {
2566 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 -06002567 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002568 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002569 "depth [%1d].",
2570 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002571 }
2572
Dave Houltonee281a52017-12-08 13:51:02 -07002573 // Adjust dest extent if necessary
2574 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2575 if (slice_override) dst_copy_extent.depth = depth_slices;
2576
2577 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002578 if (extent_check & x_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-dstOffset-00150",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002581 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002582 "width [%1d].",
2583 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002584 }
2585 if (extent_check & y_bit) {
2586 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 -06002587 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002588 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002589 "height [%1d].",
2590 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002591 }
2592 if (extent_check & z_bit) {
2593 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002594 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002595 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002596 "depth [%1d].",
2597 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002598 }
2599
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002600 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2601 // must not overlap in memory
2602 if (src_image_state->image == dst_image_state->image) {
2603 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002604 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2605 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002606 std::stringstream ss;
2607 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2608 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 -06002609 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002610 }
2611 }
2612 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002613 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002614
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002615 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2616 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2617 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002618 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002619 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2620 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002621 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 -06002622 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002623 }
2624 } else {
Tony-LunarG7482ca92018-10-01 14:20:22 -06002625 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, region_count, regions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2627 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 -06002628 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002629 }
2630 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002631
Dave Houlton33c22b72017-02-28 13:16:02 -07002632 // Source and dest image sample counts must match
2633 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2634 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2635 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 -06002636 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002637 }
2638
Dave Houltond8ed0212018-05-16 17:18:24 -06002639 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2640 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002641 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002642 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2643 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2644 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2645 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002646 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002647 skip |=
2648 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002649 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002650 skip |=
2651 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002652 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002653 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002654 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002655 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2656 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002657 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002658 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002659 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07002660 const std::string invalid_src_layout_vuid =
2661 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2662 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2663 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2664 const std::string invalid_dst_layout_vuid =
2665 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2666 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2667 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002668 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002669 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002670 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2671 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002672 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002673 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2674 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002675 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2676 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002677 }
2678
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002679 return skip;
2680}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002681
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002682void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002683 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2684 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2685 // Make sure that all image slices are updated to correct layout
2686 for (uint32_t i = 0; i < region_count; ++i) {
2687 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2688 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2689 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002690 // Update bindings between images and cmd buffer
2691 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2692 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002693}
2694
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002695// Returns true if sub_rect is entirely contained within rect
2696static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2697 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2698 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2699 return false;
2700 return true;
2701}
2702
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002703bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2704 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002705 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002706 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2707
2708 bool skip = false;
2709 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002710 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002711 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002712 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002713 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002714 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002715 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2716 // 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 -07002717 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2718 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002719 skip |= log_msg(
2720 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002721 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002722 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2723 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2724 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002725 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002726 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002727 }
2728
2729 // Validate that attachment is in reference list of active subpass
2730 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002731 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2732 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002733 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002734
2735 for (uint32_t i = 0; i < attachmentCount; i++) {
2736 auto clear_desc = &pAttachments[i];
2737 VkImageView image_view = VK_NULL_HANDLE;
2738
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002739 if (0 == clear_desc->aspectMask) {
2740 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 -06002741 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002742 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2743 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 -06002744 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002745 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002746 if ((subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment != VK_ATTACHMENT_UNUSED) &&
2747 (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002748 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 -07002749 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2750 "vkCmdClearAttachments() color attachment index %d is not VK_ATTACHMENT_UNUSED and is out of "
2751 "range for active subpass %d.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002752 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002753 } else {
2754 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002755 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002756 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002757 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2758 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2759 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002760 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002761 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 -06002762 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002763 }
2764 } else { // Must be depth and/or stencil
2765 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2766 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002767 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002768 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 -06002769 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002770 }
2771 if (!subpass_desc->pDepthStencilAttachment ||
2772 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2773 skip |= log_msg(
2774 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002775 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002776 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002777 } else {
2778 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2779 }
2780 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002781 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002782 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002783 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002784 // The rectangular region specified by a given element of pRects must be contained within the render area of
2785 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002786 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2787 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2788 skip |=
2789 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 -06002790 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002791 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002792 "the current render pass instance.",
2793 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002794 }
2795 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002796 const auto local_rect =
2797 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002798 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002799 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002800 return log_msg(
2801 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002802 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002803 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002804 "the current render pass instance.",
2805 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002806 }
2807 return false;
2808 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002809 }
2810 // The layers specified by a given element of pRects must be contained within every attachment that
2811 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002812 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002813 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2814 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002815 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 -06002816 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00017",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002817 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002818 "of pAttachment[%d].",
2819 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002820 }
2821 }
2822 }
2823 }
2824 }
2825 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002826}
2827
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002828bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Cort Stratton7df30962018-05-17 19:45:57 -07002829 VkImageLayout src_image_layout, IMAGE_STATE *dst_image_state, VkImageLayout dst_image_layout,
2830 uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002831 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002832 bool skip = false;
2833 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002834 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2835 "VUID-vkCmdResolveImage-srcImage-00256");
2836 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2837 "VUID-vkCmdResolveImage-dstImage-00258");
2838 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2839 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002840 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002841 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002842 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002843 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2844 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002845
Cort Stratton7df30962018-05-17 19:45:57 -07002846 bool hit_error = false;
2847 const std::string invalid_src_layout_vuid =
2848 (src_image_state->shared_presentable &&
2849 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2850 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2851 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2852 const std::string invalid_dst_layout_vuid =
2853 (dst_image_state->shared_presentable &&
2854 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2855 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2856 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002857 // For each region, the number of layers in the image subresource should not be zero
2858 // For each region, src and dest image aspect must be color only
2859 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002860 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2861 "srcSubresource", i);
2862 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2863 "dstSubresource", i);
Cort Stratton7df30962018-05-17 19:45:57 -07002864 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, src_image_layout,
2865 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2866 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
2867 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dst_image_layout,
2868 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2869 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002870 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2871 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2872 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2873 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2874 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2875 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2876 "VUID-vkCmdResolveImage-srcSubresource-01711");
2877 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2878 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2879 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002880
2881 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002882 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2883 skip |= log_msg(
2884 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002885 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002886 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002887 }
Cort Stratton7df30962018-05-17 19:45:57 -07002888 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002889 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2890 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2891 char const str[] =
2892 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2893 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 -06002894 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002895 }
2896 }
2897
2898 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2899 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002900 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 -06002901 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002902 }
2903 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2904 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002905 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 -06002906 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002907 }
2908 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2909 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2910 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 -06002911 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002912 }
2913 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2914 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2915 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 -06002916 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002917 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002918 } else {
2919 assert(0);
2920 }
2921 return skip;
2922}
2923
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002924void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2925 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002926 // Update bindings between images and cmd buffer
2927 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2928 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002929}
2930
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002931bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002932 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2933 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002934 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2935
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002936 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002937 if (cb_node) {
2938 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2939 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002940 if (cb_node && src_image_state && dst_image_state) {
2941 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002942 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002943 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002944 "VUID-vkCmdBlitImage-dstImage-00234");
2945 skip |=
2946 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2947 skip |=
2948 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
2949 skip |=
2950 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2951 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2952 skip |=
2953 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2954 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2955 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
2956 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002957 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002958 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002959 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002960 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04002961 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002962 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002963
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002964 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002965
Dave Houlton33c2d252017-06-09 17:08:32 -06002966 VkFormat src_format = src_image_state->createInfo.format;
2967 VkFormat dst_format = dst_image_state->createInfo.format;
2968 VkImageType src_type = src_image_state->createInfo.imageType;
2969 VkImageType dst_type = dst_image_state->createInfo.imageType;
2970
Cort Stratton186b1a22018-05-01 20:18:06 -04002971 if (VK_FILTER_LINEAR == filter) {
2972 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002973 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2974 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002975 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002976 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
2977 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002978 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002979 }
2980
2981 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2982 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 -06002983 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002984 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002985 }
2986
Dave Houlton33c2d252017-06-09 17:08:32 -06002987 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2988 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2989 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 -06002990 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002991 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002992 }
2993
2994 // Validate consistency for unsigned formats
2995 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2996 std::stringstream ss;
2997 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2998 << "the other one must also have unsigned integer format. "
2999 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3000 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003001 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003002 }
3003
3004 // Validate consistency for signed formats
3005 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3006 std::stringstream ss;
3007 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
3008 << "the other one must also have signed integer format. "
3009 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3010 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003011 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003012 }
3013
3014 // Validate filter for Depth/Stencil formats
3015 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3016 std::stringstream ss;
3017 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
3018 << "then filter must be VK_FILTER_NEAREST.";
3019 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 -06003020 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003021 }
3022
3023 // Validate aspect bits and formats for depth/stencil images
3024 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3025 if (src_format != dst_format) {
3026 std::stringstream ss;
3027 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
3028 << "stencil, the other one must have exactly the same format. "
3029 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3030 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003031 skip |=
3032 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3033 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003034 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003035 } // Depth or Stencil
3036
3037 // Do per-region checks
Cort Stratton7df30962018-05-17 19:45:57 -07003038 const std::string invalid_src_layout_vuid =
3039 (src_image_state->shared_presentable &&
3040 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3041 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3042 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3043 const std::string invalid_dst_layout_vuid =
3044 (dst_image_state->shared_presentable &&
3045 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3046 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3047 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003048 for (uint32_t i = 0; i < region_count; i++) {
3049 const VkImageBlit rgn = regions[i];
3050 bool hit_error = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06003051 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003052 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3053 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Dave Houltond8ed0212018-05-16 17:18:24 -06003054 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003055 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3056 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003057 skip |=
3058 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3059 skip |=
3060 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003061 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3062 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3063 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3064 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3065 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3066 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3067 "VUID-vkCmdBlitImage-srcSubresource-01707");
3068 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3069 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3070 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003071 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003072 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3073 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003074 std::stringstream ss;
3075 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003076 skip |=
3077 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3078 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003079 }
Dave Houlton48989f32017-05-26 15:01:46 -06003080 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3081 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003082 std::stringstream ss;
3083 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003084 skip |=
3085 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3086 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003087 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003088
3089 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003090 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003091 skip |=
3092 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003093 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003094 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003095 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003096
Dave Houlton48989f32017-05-26 15:01:46 -06003097 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003098 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 -06003099 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003100 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003101 }
Dave Houlton48989f32017-05-26 15:01:46 -06003102
Dave Houlton33c2d252017-06-09 17:08:32 -06003103 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3104 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003105 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Dave Houlton33c2d252017-06-09 17:08:32 -06003106 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003107 "image format %s.",
3108 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003109 }
3110
3111 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3112 skip |= log_msg(
3113 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003114 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003115 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
3116 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003117 }
3118
Dave Houlton48989f32017-05-26 15:01:46 -06003119 // Validate source image offsets
3120 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003121 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003122 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
3123 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 -06003124 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
Dave Houlton48989f32017-05-26 15:01:46 -06003125 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003126 "of (%1d, %1d). These must be (0, 1).",
3127 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003128 }
3129 }
3130
Dave Houlton33c2d252017-06-09 17:08:32 -06003131 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003132 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3133 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 -06003134 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Dave Houlton48989f32017-05-26 15:01:46 -06003135 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003136 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3137 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003138 }
3139 }
3140
Dave Houlton33c2d252017-06-09 17:08:32 -06003141 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003142 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3143 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003144 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003145 skip |=
3146 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-srcOffset-00243",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003148 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3149 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003150 }
3151 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3152 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003153 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003154 skip |= log_msg(
3155 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003156 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003157 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
3158 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003159 }
3160 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3161 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003162 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003163 skip |=
3164 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 -06003165 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003166 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3167 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003168 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003169 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003170 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 -06003171 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003172 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003173 }
Dave Houlton48989f32017-05-26 15:01:46 -06003174
3175 // Validate dest image offsets
3176 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003177 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003178 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
3179 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 -06003180 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
Dave Houlton48989f32017-05-26 15:01:46 -06003181 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003182 "(%1d, %1d). These must be (0, 1).",
3183 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003184 }
3185 }
3186
Dave Houlton33c2d252017-06-09 17:08:32 -06003187 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003188 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3189 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 -06003190 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Dave Houlton48989f32017-05-26 15:01:46 -06003191 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003192 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3193 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003194 }
3195 }
3196
Dave Houlton33c2d252017-06-09 17:08:32 -06003197 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003198 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3199 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003200 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003201 skip |=
3202 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-dstOffset-00248",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003204 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
3205 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003206 }
3207 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3208 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003209 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003210 skip |= log_msg(
3211 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003212 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003213 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
3214 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003215 }
3216 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3217 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003218 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003219 skip |=
3220 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 -06003221 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003222 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
3223 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003224 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003225 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003226 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 -06003227 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003228 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003229 }
3230
Dave Houlton33c2d252017-06-09 17:08:32 -06003231 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3232 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3233 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
3234 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 -06003235 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
Dave Houlton33c2d252017-06-09 17:08:32 -06003236 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003237 "layerCount other than 1.",
3238 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003239 }
3240 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003241 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003242 } else {
3243 assert(0);
3244 }
3245 return skip;
3246}
3247
Tobin Ehlis58c884f2017-02-08 12:15:27 -07003248void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003249 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
3250 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
3251 // Make sure that all image slices are updated to correct layout
3252 for (uint32_t i = 0; i < region_count; ++i) {
3253 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
3254 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
3255 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003256 // Update bindings between images and cmd buffer
3257 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3258 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003259}
3260
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003261// 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 -07003262bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003263 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3264 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003265 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07003266 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003267 for (auto cb_image_data : pCB->imageLayoutMap) {
3268 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003269
Dave Houltonb3f4b282018-02-22 16:25:16 -07003270 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3271 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003272 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3273 // TODO: Set memory invalid which is in mem_tracker currently
3274 } else if (imageLayout != cb_image_data.second.initialLayout) {
3275 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003276 skip |= log_msg(
3277 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003278 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003279 "Submitted command buffer expects image 0x%" PRIx64
3280 " (subresource: aspectMask 0x%X array layer %u, mip level %u) to be in layout %s--instead, image 0x%" PRIx64
3281 "'s current layout is %s.",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003282 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
3283 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003284 string_VkImageLayout(cb_image_data.second.initialLayout), HandleToUint64(cb_image_data.first.image),
3285 string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003286 } else {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003287 skip |=
3288 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3289 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3290 "Submitted command buffer expects image 0x%" PRIx64 " to be in layout %s--instead, image 0x%" PRIx64
3291 "'s current layout is %s.",
3292 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(cb_image_data.second.initialLayout),
3293 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003294 }
3295 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003296 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003297 }
3298 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003299 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003300}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003301
Tony Barbourdf013b92017-01-25 12:53:48 -07003302void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
3303 for (auto cb_image_data : pCB->imageLayoutMap) {
3304 VkImageLayout imageLayout;
3305 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3306 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3307 }
3308}
3309
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003310// Print readable FlagBits in FlagMask
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003311static std::string StringVkAccessFlags(VkAccessFlags accessMask) {
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003312 std::string result;
3313 std::string separator;
3314
3315 if (accessMask == 0) {
3316 result = "[None]";
3317 } else {
3318 result = "[";
3319 for (auto i = 0; i < 32; i++) {
3320 if (accessMask & (1 << i)) {
3321 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
3322 separator = " | ";
3323 }
3324 }
3325 result = result + "]";
3326 }
3327 return result;
3328}
3329
Dave Houlton12befb92018-06-26 17:16:46 -06003330#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 -06003331 // validation ToBeRemoved (disabled 6/18)
Dave Houlton12befb92018-06-26 17:16:46 -06003332
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003333// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
3334// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003335// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003336static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
3337 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
3338 const char *type) {
3339 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3340 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003341
3342 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
3343 if (accessMask & ~(required_bit | optional_bits)) {
3344 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003345 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 -06003346 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003347 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003348 StringVkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003349 }
3350 } else {
3351 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003352 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 -06003353 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003354 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
3355 "has previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003356 type, accessMask, StringVkAccessFlags(accessMask).c_str(), optional_bits,
3357 StringVkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003358 } else {
3359 std::string opt_bits;
3360 if (optional_bits != 0) {
3361 std::stringstream ss;
3362 ss << optional_bits;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003363 opt_bits = "and may have optional bits " + ss.str() + ' ' + StringVkAccessFlags(optional_bits);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003364 }
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 have required access bit %d %s %s when layout is %s, unless the app has "
3368 "previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003369 type, accessMask, StringVkAccessFlags(accessMask).c_str(), required_bit,
3370 StringVkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003371 }
3372 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003373 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003374}
Dave Houlton12befb92018-06-26 17:16:46 -06003375#endif
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003376
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003377// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003378// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3379// layout attachments don't have CLEAR as their loadOp.
Tobias Hectorbbb12282018-10-22 15:17:59 +01003380bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3381 const VkImageLayout first_layout, const uint32_t attachment,
3382 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003383 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003384 const char *vuid;
3385 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3386
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003387 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3388 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003389 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3390 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3391 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003392 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003393 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3394 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3395 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3396 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3397 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3398 skip |=
3399 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3400 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003401 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003402 }
3403 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003404 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3405 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003406 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003407 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003408 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 -06003409 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003410 }
3411 }
3412
3413 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3414 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003415 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003416 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003417 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 -06003418 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003419 }
3420 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003421 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003422}
3423
Tobias Hectorbbb12282018-10-22 15:17:59 +01003424bool ValidateLayouts(const core_validation::layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3425 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003426 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003427 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003428 const char *vuid;
3429 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3430 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003431
Jason Ekstranda1906302017-12-03 20:16:32 -08003432 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3433 VkFormat format = pCreateInfo->pAttachments[i].format;
3434 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3435 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3436 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003437 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 -06003438 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003439 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3440 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3441 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3442 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003443 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003444 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003445 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 -06003446 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003447 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3448 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3449 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3450 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003451 }
3452 }
3453 }
3454
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003455 // Track when we're observing the first use of an attachment
3456 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3457 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003458 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003459
3460 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3461 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3462 auto attach_index = subpass.pInputAttachments[j].attachment;
3463 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003464 switch (subpass.pInputAttachments[j].layout) {
3465 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3466 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3467 // These are ideal.
3468 break;
3469
3470 case VK_IMAGE_LAYOUT_GENERAL:
3471 // May not be optimal. TODO: reconsider this warning based on other constraints.
3472 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003473 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003474 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3475 break;
3476
Tobias Hectorbbb12282018-10-22 15:17:59 +01003477 case VK_IMAGE_LAYOUT_UNDEFINED:
3478 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3479 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3480 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3481 "Layout for input attachment reference %u in subpass %u is %s but must be "
3482 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3483 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3484 break;
3485
Graeme Leese668a9862018-10-08 10:40:02 +01003486 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3487 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3488 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3489 break;
3490 } else {
3491 // Intentionally fall through to generic error message
3492 }
3493 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003494
Cort Stratton7547f772017-05-04 15:18:52 -07003495 default:
3496 // No other layouts are acceptable
3497 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 -06003498 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003499 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3500 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3501 }
3502
Cort Stratton7547f772017-05-04 15:18:52 -07003503 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003504 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3505 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003506
3507 bool used_as_depth =
3508 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3509 bool used_as_color = false;
3510 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3511 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3512 }
3513 if (!used_as_depth && !used_as_color &&
3514 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003515 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3516 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3517 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3518 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003519 }
3520 }
3521 attach_first_use[attach_index] = false;
3522 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003523
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003524 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3525 auto attach_index = subpass.pColorAttachments[j].attachment;
3526 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3527
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003528 // TODO: Need a way to validate shared presentable images here, currently just allowing
3529 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3530 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003531 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003532 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003533 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003534 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3535 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003536 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003537
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003538 case VK_IMAGE_LAYOUT_GENERAL:
3539 // May not be optimal; TODO: reconsider this warning based on other constraints?
3540 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003541 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003542 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3543 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003544
Tobias Hectorbbb12282018-10-22 15:17:59 +01003545 case VK_IMAGE_LAYOUT_UNDEFINED:
3546 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3547 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3548 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3549 "Layout for color attachment reference %u in subpass %u is %s but should be "
3550 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3551 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3552 break;
3553
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003554 default:
3555 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 -06003556 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003557 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3558 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003559 }
3560
Tobias Hectorbbb12282018-10-22 15:17:59 +01003561 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3562 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
3563 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3564 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3565 "Layout for color attachment reference %u in subpass %u is %s but should be "
3566 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3567 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3568 }
3569
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003570 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003571 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3572 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003573 }
3574 attach_first_use[attach_index] = false;
3575 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003576
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003577 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3578 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003579 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3580 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3581 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003582 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003583
Dave Houltona9df0ce2018-02-07 10:51:23 -07003584 case VK_IMAGE_LAYOUT_GENERAL:
3585 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3586 // doing a bunch of transitions.
3587 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003588 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003589 "GENERAL layout for depth attachment may not give optimal performance.");
3590 break;
3591
Tobias Hectorbbb12282018-10-22 15:17:59 +01003592 case VK_IMAGE_LAYOUT_UNDEFINED:
3593 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3594 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3595 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3596 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3597 "layout or GENERAL.",
3598 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3599 break;
3600
Dave Houltona9df0ce2018-02-07 10:51:23 -07003601 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3602 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3603 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3604 break;
3605 } else {
3606 // Intentionally fall through to generic error message
3607 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003608 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003609
Dave Houltona9df0ce2018-02-07 10:51:23 -07003610 default:
3611 // No other layouts are acceptable
3612 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 -06003613 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003614 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3615 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3616 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003617 }
3618
3619 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3620 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003621 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3622 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003623 }
3624 attach_first_use[attach_index] = false;
3625 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003626 }
3627 return skip;
3628}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003629
3630// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003631bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3632 VkDeviceSize offset, VkDeviceSize end_offset) {
3633 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3634 bool skip = false;
3635 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3636 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003637 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3638 for (auto image_handle : mem_info->bound_images) {
3639 auto img_it = mem_info->bound_ranges.find(image_handle);
3640 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003641 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003642 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003643 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003644 for (auto layout : layouts) {
3645 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003646 skip |=
3647 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 -06003648 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003649 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3650 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003651 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003652 }
3653 }
3654 }
3655 }
3656 }
3657 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003658 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003659}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003660
3661// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3662// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003663static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3664 VulkanObjectType obj_type, std::string msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003665 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003666
3667 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003668 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003669 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003670 if (strict) {
3671 correct_usage = ((actual & desired) == desired);
3672 } else {
3673 correct_usage = ((actual & desired) != 0);
3674 }
3675 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003676 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003677 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003678 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003679 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 -06003680 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003681 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3682 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003683 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003684 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003685 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 -06003686 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3687 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003688 }
3689 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003690 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003691}
3692
3693// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3694// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003695bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003696 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003697 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3698 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003699}
3700
Cort Stratton186b1a22018-05-01 20:18:06 -04003701bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Dave Houltone0969282018-05-23 15:54:31 -06003702 char const *func_name, const std::string &linear_vuid, const std::string &optimal_vuid) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003703 VkFormatProperties format_properties = GetPDFormatProperties(dev_data, image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003704 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3705 bool skip = false;
3706 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3707 if ((format_properties.linearTilingFeatures & desired) != desired) {
3708 skip |=
3709 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3710 HandleToUint64(image_state->image), linear_vuid,
3711 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3712 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3713 }
3714 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3715 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3717 HandleToUint64(image_state->image), optimal_vuid,
3718 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3719 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3720 HandleToUint64(image_state->image));
3721 }
3722 }
3723 return skip;
3724}
3725
Cort Strattond619a302018-05-17 19:46:32 -07003726bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3727 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3728 uint32_t i) {
3729 bool skip = false;
3730 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3731 // layerCount must not be zero
3732 if (subresource_layers->layerCount == 0) {
3733 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3734 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3735 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3736 }
3737 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3738 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3739 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3740 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3741 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3742 }
3743 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3744 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3745 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
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-aspectMask-00167",
3748 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3749 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3750 func_name, i, member);
3751 }
3752 return skip;
3753}
3754
Mark Lobodzinski96210742017-02-09 10:33:46 -07003755// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3756// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003757bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003758 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003759 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3760 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003761}
3762
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003763bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3764 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3765 bool skip = false;
3766 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3767
3768 const VkDeviceSize &range = pCreateInfo->range;
3769 if (range != VK_WHOLE_SIZE) {
3770 // Range must be greater than 0
3771 if (range <= 0) {
3772 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3773 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3774 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3775 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3776 range);
3777 }
3778 // Range must be a multiple of the element size of format
3779 const size_t format_size = FormatSize(pCreateInfo->format);
3780 if (range % format_size != 0) {
3781 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3782 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3783 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3784 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3785 "(" PRINTF_SIZE_T_SPECIFIER ").",
3786 range, format_size);
3787 }
3788 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3789 if (range / format_size > device_limits->maxTexelBufferElements) {
3790 skip |=
3791 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3792 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3793 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3794 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3795 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3796 range, format_size, device_limits->maxTexelBufferElements);
3797 }
3798 // The sum of range and offset must be less than or equal to the size of buffer
3799 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3801 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3802 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3803 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3804 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3805 range, pCreateInfo->offset, buffer_state->createInfo.size);
3806 }
3807 }
3808 return skip;
3809}
3810
Shannon McPherson265383a2018-06-21 15:37:52 -06003811bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3812 const VkBufferViewCreateInfo *pCreateInfo) {
3813 bool skip = false;
3814 const debug_report_data *report_data = GetReportData(device_data);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003815 const VkFormatProperties format_properties = GetPDFormatProperties(device_data, pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003816 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3817 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3818 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3819 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3820 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3821 "be supported for uniform texel buffers");
3822 }
3823 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3824 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3825 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3826 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3827 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3828 "be supported for storage texel buffers");
3829 }
3830 return skip;
3831}
3832
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003833bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003834 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003835 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3836
Dave Houltond8ed0212018-05-16 17:18:24 -06003837 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003838
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003839 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003840 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 -06003841 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003842 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003843 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003844 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003845
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003846 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3847 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003848 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 -06003849 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003850 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003851 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003852 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003853
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003854 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3855 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003856 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 -06003857 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003858 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003859 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003860 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003861 return skip;
3862}
3863
3864void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3865 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3866 GetBufferMap(device_data)
3867 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3868}
3869
Shannon McPhersona84241a2018-06-18 15:34:46 -06003870bool PreCallValidateCreateBufferView(const layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003871 bool skip = false;
Shannon McPherson883f6092018-06-14 13:15:25 -06003872 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003873 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003874 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3875 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003876 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3877 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003878 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3879 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003880 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3881 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3882 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3883 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003884
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003885 // Buffer view offset must be less than the size of buffer
3886 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3887 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3888 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3889 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3890 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3891 pCreateInfo->offset, buffer_state->createInfo.size);
3892 }
3893
Shannon McPherson883f6092018-06-14 13:15:25 -06003894 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
3895 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3896 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3897 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3898 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3899 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3900 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3901 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3902 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003903
3904 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003905
3906 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003907 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003908 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003909}
3910
3911void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3912 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3913}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003914
3915// For the given format verify that the aspect masks make sense
Tobias Hectorbbb12282018-10-22 15:17:59 +01003916bool ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3917 const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003918 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3919 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003920 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3921 if (image != VK_NULL_HANDLE) {
3922 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3923 }
3924
Dave Houlton1d2022c2017-03-29 11:43:58 -06003925 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003926 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003927 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003928 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003929 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003930 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003931 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003932 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003933 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003934 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003935 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003936 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003937 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3938 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003939 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003940 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003941 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003942 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3943 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003944 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003945 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003946 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003947 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003948 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003949 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003950 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003951 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003952 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003953 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003954 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003955 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003956 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003957 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003958 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003959 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003960 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003961 } else if (FormatIsMultiplane(format)) {
3962 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3963 if (3 == FormatPlaneCount(format)) {
3964 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3965 }
3966 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003967 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003968 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3969 "set, where n = [0, 1, 2].",
3970 func_name);
3971 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003972 }
3973 return skip;
3974}
3975
Petr Krausffa94af2017-08-08 21:46:02 +02003976struct SubresourceRangeErrorCodes {
Dave Houltond8ed0212018-05-16 17:18:24 -06003977 std::string base_mip_err, mip_count_err, base_layer_err, layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02003978};
3979
3980bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3981 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3982 const char *image_layer_count_var_name, const uint64_t image_handle,
3983 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003984 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3985 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003986
3987 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003988 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003989 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 -06003990 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003991 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003992 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3993 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003994 }
Petr Kraus4d718682017-05-18 03:38:41 +02003995
Petr Krausffa94af2017-08-08 21:46:02 +02003996 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3997 if (subresourceRange.levelCount == 0) {
3998 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 -06003999 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004000 } else {
4001 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004002
Petr Krausffa94af2017-08-08 21:46:02 +02004003 if (necessary_mip_count > image_mip_count) {
4004 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 -06004005 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004006 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004007 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004008 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004009 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004010 }
Petr Kraus4d718682017-05-18 03:38:41 +02004011 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004012 }
Petr Kraus4d718682017-05-18 03:38:41 +02004013
4014 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004015 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004016 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 -06004017 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004018 "%s: %s.baseArrayLayer (= %" PRIu32
4019 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4020 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004021 }
Petr Kraus4d718682017-05-18 03:38:41 +02004022
Petr Krausffa94af2017-08-08 21:46:02 +02004023 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4024 if (subresourceRange.layerCount == 0) {
4025 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 -06004026 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004027 } else {
4028 const uint64_t necessary_layer_count =
4029 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004030
Petr Krausffa94af2017-08-08 21:46:02 +02004031 if (necessary_layer_count > image_layer_count) {
4032 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 -06004033 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004034 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004035 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004036 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004037 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004038 }
Petr Kraus4d718682017-05-18 03:38:41 +02004039 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004040 }
Petr Kraus4d718682017-05-18 03:38:41 +02004041
Mark Lobodzinski602de982017-02-09 11:01:33 -07004042 return skip;
4043}
4044
Petr Krausffa94af2017-08-08 21:46:02 +02004045bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4046 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
4047 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
4048 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4049 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4050 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4051
4052 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4053 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4054
4055 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004056 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4057 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4058 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4059 : "VUID-VkImageViewCreateInfo-image-01482")
4060 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4061 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4062 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4063 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4064 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004065
4066 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4067 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4068 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4069}
4070
4071bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4072 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4073 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004074 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4075 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4076 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4077 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004078
4079 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4080 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4081 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4082}
4083
4084bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4085 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4086 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004087 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4088 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4089 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4090 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004091
4092 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4093 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4094 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4095}
4096
4097bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4098 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4099 const char *param_name) {
4100 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004101 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4102 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4103 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4104 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004105
4106 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4107 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4108 subresourceRangeErrorCodes);
4109}
4110
Mark Lobodzinski602de982017-02-09 11:01:33 -07004111bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
4112 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4113 bool skip = false;
4114 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
4115 if (image_state) {
4116 skip |= ValidateImageUsageFlags(
4117 device_data, image_state,
4118 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004119 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4120 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004121 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004122 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004123 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004124 skip |=
4125 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004126 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004127 skip |= ValidateCreateImageViewSubresourceRange(
4128 device_data, image_state,
4129 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4130 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004131
4132 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4133 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004134 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4135 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004136 VkFormat view_format = create_info->format;
4137 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004138 VkImageType image_type = image_state->createInfo.imageType;
4139 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004140
Dave Houltonbd2e2622018-04-10 16:41:14 -06004141 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
4142 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
4143 if (chained_ivuci_struct) {
4144 if (chained_ivuci_struct->usage & ~image_usage) {
4145 std::stringstream ss;
4146 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004147 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004148 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004149 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4150 HandleToUint64(create_info->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
4151 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004152 }
4153
4154 image_usage = chained_ivuci_struct->usage;
4155 }
4156
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004157 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4158 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004159 if (FormatIsMultiplane(image_format)) {
4160 // View format must match the multiplane compatible format
4161 uint32_t plane = 3; // invalid
4162 switch (aspect_mask) {
4163 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4164 plane = 0;
4165 break;
4166 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4167 plane = 1;
4168 break;
4169 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4170 plane = 2;
4171 break;
4172 default:
4173 break;
4174 }
4175
4176 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4177 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004178 std::stringstream ss;
4179 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004180 << " is not compatible with plane " << plane << " of underlying image format "
4181 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004182 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4183 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
4184 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004185 }
4186 } else {
4187 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
4188 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4189 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4190 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4191 std::stringstream ss;
4192 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
4193 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
4194 << ") format " << string_VkFormat(image_format)
4195 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4196 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004197 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4198 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
4199 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004200 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004201 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004202 }
4203 } else {
4204 // Format MUST be IDENTICAL to the format the image was created with
4205 if (image_format != view_format) {
4206 std::stringstream ss;
4207 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02004208 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004209 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004210 skip |=
4211 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4212 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004213 }
4214 }
4215
4216 // Validate correct image aspect bits for desired formats and format consistency
4217 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004218
4219 switch (image_type) {
4220 case VK_IMAGE_TYPE_1D:
4221 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004222 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4223 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004224 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4225 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004226 }
4227 break;
4228 case VK_IMAGE_TYPE_2D:
4229 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4230 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4231 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004232 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4233 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004234 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4235 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004236 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004237 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4238 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004239 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4240 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004241 }
4242 }
4243 break;
4244 case VK_IMAGE_TYPE_3D:
4245 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4246 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4247 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4248 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004249 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004250 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4251 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004252 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4253 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004254 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4255 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004256 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004257 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4258 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004259 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4260 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004261 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4262 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004263 }
4264 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004265 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4266 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004267 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4268 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004269 }
4270 }
4271 } else {
4272 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004273 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4274 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004275 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4276 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004277 }
4278 }
4279 break;
4280 default:
4281 break;
4282 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004283
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004284 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
4285 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
4286 skip |= ValidateCreateImageViewANDROID(device_data, create_info);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004287 }
4288
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004289 VkFormatProperties format_properties = GetPDFormatProperties(device_data, view_format);
4290 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4291 : format_properties.optimalTilingFeatures;
4292
4293 if (tiling_features == 0) {
4294 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4295 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-None-02273",
4296 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4297 "physical device.",
4298 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4299 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4300 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4301 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02274",
4302 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4303 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4304 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4305 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4306 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4307 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02275",
4308 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4309 "VK_IMAGE_USAGE_STORAGE_BIT.",
4310 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4311 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4312 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4313 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4314 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02276",
4315 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4316 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4317 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4318 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4319 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4320 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4321 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02277",
4322 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4323 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4324 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004325 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004326
Jeff Bolz9af91c52018-09-01 21:53:57 -05004327 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4328 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4329 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4330 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02086",
4331 "vkCreateImageView() If image was created with usage containing "
4332 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4333 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4334 }
4335 if (view_format != VK_FORMAT_R8_UINT) {
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-image-02087",
4338 "vkCreateImageView() If image was created with usage containing "
4339 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4340 }
4341 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004342 }
4343 return skip;
4344}
4345
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004346void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
4347 auto image_view_map = GetImageViewMap(device_data);
4348 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
4349
4350 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004351 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004352 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4353 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004354}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004355
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004356bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4357 BUFFER_STATE *dst_buffer_state) {
4358 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004359 skip |=
4360 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4361 skip |=
4362 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004363 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004364 skip |=
4365 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4366 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4367 skip |=
4368 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4369 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004370 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004371 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4372 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004373 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004374 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004375 return skip;
4376}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004377
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004378void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4379 BUFFER_STATE *dst_buffer_state) {
4380 // Update bindings between buffers and cmd buffer
4381 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4382 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004383}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004384
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004385static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004386 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4387 bool skip = false;
4388 auto buffer_state = GetBufferState(device_data, buffer);
4389 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004390 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 -06004391 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01004392 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004393 } else {
4394 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004395 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 -06004396 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004397 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004398 }
4399 }
4400 return skip;
4401}
4402
4403bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
4404 VK_OBJECT *obj_struct) {
4405 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004406 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004407 if (GetDisables(device_data)->destroy_image_view) return false;
4408 bool skip = false;
4409 if (*image_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004410 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView",
4411 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004412 }
4413 return skip;
4414}
4415
John Zulauffca05c12018-04-26 16:30:39 -06004416void PreCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
4417 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004418 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004419 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004420 (*GetImageViewMap(device_data)).erase(image_view);
4421}
4422
4423bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
4424 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02004425 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004426 if (GetDisables(device_data)->destroy_buffer) return false;
4427 bool skip = false;
4428 if (*buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004429 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004430 }
4431 return skip;
4432}
4433
John Zulauffca05c12018-04-26 16:30:39 -06004434void PreCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004435 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004436 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4437 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4438 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004439 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004440 }
4441 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004442 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004443 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004444 GetBufferMap(device_data)->erase(buffer_state->buffer);
4445}
4446
4447bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
4448 VK_OBJECT *obj_struct) {
4449 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004450 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004451 if (GetDisables(device_data)->destroy_buffer_view) return false;
4452 bool skip = false;
4453 if (*buffer_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004454 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView",
4455 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004456 }
4457 return skip;
4458}
4459
John Zulauffca05c12018-04-26 16:30:39 -06004460void PreCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
4461 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004462 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004463 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004464 GetBufferViewMap(device_data)->erase(buffer_view);
4465}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004466
4467bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
4468 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004469 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004470 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004471 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4472 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004473 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4474 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004475 skip |=
4476 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4477 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004478 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004479 return skip;
4480}
4481
4482void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004483 // Update bindings between buffer and cmd buffer
4484 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004485}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004486
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004487bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4488 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004489 bool skip = false;
4490
4491 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004492 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4493 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004494 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 -06004495 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004496 "%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 -06004497 "and 1, respectively.",
4498 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004499 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004500 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004501
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004502 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4503 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004504 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 -06004505 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004506 "%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 -06004507 "must be 0 and 1, respectively.",
4508 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004509 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004510 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004511
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004512 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4513 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004514 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 -06004515 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004516 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4517 "For 3D images these must be 0 and 1, respectively.",
4518 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004519 }
4520 }
4521
4522 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
4523 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06004524 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06004525 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004526 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 -06004527 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004528 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004529 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
4530 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004531 }
4532
4533 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004534 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004535 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 -06004536 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004537 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4538 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004539 }
4540
4541 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4542 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004543 skip |=
4544 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004545 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004546 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4547 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004548 }
4549
4550 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4551 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4552 skip |= log_msg(
4553 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004554 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004555 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4556 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004557 }
4558
4559 // subresource aspectMask must have exactly 1 bit set
4560 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4561 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4562 if (aspect_mask_bits.count() != 1) {
4563 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 -06004564 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004565 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004566 }
4567
4568 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004569 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004570 skip |= log_msg(
4571 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004572 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004573 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4574 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004575 }
4576
4577 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004578 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004579 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004580
4581 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004582 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004583 skip |= log_msg(
4584 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004585 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004586 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4587 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004588 }
4589
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004590 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004591 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004592 skip |= log_msg(
4593 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004594 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004595 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4596 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004597 }
4598
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004599 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004600 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4601 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4602 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004603 skip |=
4604 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004605 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004606 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4607 "width & height (%d, %d)..",
4608 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004609 }
4610
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004611 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004612 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
4613 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004614 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 -06004615 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004616 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4617 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
4618 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004619 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004620
4621 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004622 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004623 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004624 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4625 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 -06004626 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004627 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004628 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004629 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004630 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004631 }
4632
4633 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004634 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004635 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4636 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 -06004637 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004638 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004639 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004640 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004641 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004642 }
4643
4644 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004645 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004646 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4647 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 -06004648 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004649 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004650 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004651 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004652 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004653 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004654 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004655 }
4656
4657 return skip;
4658}
4659
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004660static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Dave Houltond8ed0212018-05-16 17:18:24 -06004661 const VkBufferImageCopy *pRegions, const char *func_name, std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004662 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004663 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004664
4665 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004666 VkExtent3D extent = pRegions[i].imageExtent;
4667 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004668
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004669 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4670 {
Dave Houlton51653902018-06-22 17:32:13 -06004671 skip |=
4672 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4673 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4674 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004675 }
4676
4677 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4678
4679 // 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 -06004680 if (FormatIsCompressed(image_info->format)) {
4681 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004682 if (image_extent.width % block_extent.width) {
4683 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4684 }
4685 if (image_extent.height % block_extent.height) {
4686 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4687 }
4688 if (image_extent.depth % block_extent.depth) {
4689 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4690 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004691 }
4692
Dave Houltonfc1a4052017-04-27 14:32:45 -06004693 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004694 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 -06004695 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004696 }
4697 }
4698
4699 return skip;
4700}
4701
Chris Forbese8ba09a2017-06-01 17:39:02 -07004702static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004703 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06004704 std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004705 bool skip = false;
4706
4707 VkDeviceSize buffer_size = buff_state->createInfo.size;
4708
4709 for (uint32_t i = 0; i < regionCount; i++) {
4710 VkExtent3D copy_extent = pRegions[i].imageExtent;
4711
4712 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4713 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004714 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004715
Dave Houltonf3229d52017-02-21 15:59:08 -07004716 // Handle special buffer packing rules for specific depth/stencil formats
4717 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004718 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004719 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4720 switch (image_state->createInfo.format) {
4721 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004722 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004723 break;
4724 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004725 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004726 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004727 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004728 case VK_FORMAT_D24_UNORM_S8_UINT:
4729 unit_size = 4;
4730 break;
4731 default:
4732 break;
4733 }
4734 }
4735
Tom Cooperb2550c72018-10-15 13:08:41 +01004736 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004737 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06004738 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004739 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4740 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4741
4742 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4743 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4744 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004745 }
4746
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004747 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4748 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4749 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004750 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004751 } else {
4752 // Calculate buffer offset of final copied byte, + 1.
4753 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4754 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4755 max_buffer_offset *= unit_size; // convert to bytes
4756 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004757
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004758 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004759 skip |=
4760 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4761 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004762 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004763 }
4764 }
4765
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004766 return skip;
4767}
4768
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004769bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004770 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004771 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004772 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4773 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4774
4775 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004776 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004777
4778 // Command pool must support graphics, compute, or transfer operations
4779 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4780
4781 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4782 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4783 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 -06004784 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004785 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004786 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004787 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004788 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004789 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004790 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004791 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004792
4793 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004794 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4795 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4796 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4797 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4798 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004799
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004800 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004801 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4802 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4803 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004804 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004805 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4806 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004807 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4808 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004809 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4810 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004811 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004812 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004813 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004814 const std::string src_invalid_layout_vuid =
4815 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4816 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4817 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004818 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004819 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4820 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004821 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004822 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4823 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004824 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004825 "vkCmdCopyImageToBuffer()",
4826 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004827 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4828 "vkCmdCopyImageToBuffer()", "imageSubresource",
4829 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4830 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4831 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4832 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004833 }
4834 return skip;
4835}
4836
4837void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004838 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4839 VkImageLayout src_image_layout) {
4840 // Make sure that all image slices are updated to correct layout
4841 for (uint32_t i = 0; i < region_count; ++i) {
4842 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4843 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004844 // Update bindings between buffer/image and cmd buffer
4845 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004846 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004847}
4848
4849bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004850 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004851 const VkBufferImageCopy *pRegions, const char *func_name) {
4852 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4853 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4854
4855 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004856 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004857
4858 // Command pool must support graphics, compute, or transfer operations
4859 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4860 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4861 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4862 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 -06004863 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004864 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004865 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004866 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004867 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004868 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004869 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004870 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004871 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004872 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4873 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4874 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4875 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4876 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004877 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004878 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4879 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4880 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4881 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4882 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004883 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4884 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004885 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4886 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004887 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004888 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004889 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004890 const std::string dst_invalid_layout_vuid =
4891 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4892 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4893 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004894 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004895 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4896 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004897 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004898 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4899 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004900 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004901 "vkCmdCopyBufferToImage()",
4902 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004903 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4904 "vkCmdCopyBufferToImage()", "imageSubresource",
4905 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4906 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4907 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4908 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004909 }
4910 return skip;
4911}
4912
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004913void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004914 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4915 VkImageLayout dst_image_layout) {
4916 // Make sure that all image slices are updated to correct layout
4917 for (uint32_t i = 0; i < region_count; ++i) {
4918 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4919 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004920 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004921 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004922}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004923
4924bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4925 const auto report_data = core_validation::GetReportData(device_data);
4926 bool skip = false;
4927 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4928
Dave Houlton1d960ff2018-01-19 12:17:05 -07004929 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004930 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4931 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4932 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004933 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 -06004934 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004935 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004936 }
4937
4938 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4939 if (!image_entry) {
4940 return skip;
4941 }
4942
Dave Houlton1d960ff2018-01-19 12:17:05 -07004943 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004944 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004945 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4946 "VUID-vkGetImageSubresourceLayout-image-00996",
4947 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004948 }
4949
Dave Houlton1d960ff2018-01-19 12:17:05 -07004950 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004951 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004952 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4953 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4954 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4955 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004956 }
4957
Dave Houlton1d960ff2018-01-19 12:17:05 -07004958 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004959 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004960 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4961 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4962 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4963 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004964 }
4965
Dave Houlton1d960ff2018-01-19 12:17:05 -07004966 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004967 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004968 if (FormatIsMultiplane(img_format)) {
4969 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Dave Houltond8ed0212018-05-16 17:18:24 -06004970 std::string vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004971 if (FormatPlaneCount(img_format) > 2u) {
4972 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004973 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004974 }
4975 if (sub_aspect != (sub_aspect & allowed_flags)) {
4976 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 -06004977 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004978 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004979 ") must be a single-plane specifier flag.",
4980 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004981 }
4982 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004983 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004984 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004985 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004986 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004987 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004988 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004989 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004990 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004991 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 -06004992 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004993 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004994 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004995 }
4996 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004997
4998 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
4999 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
5000 }
5001
Mike Weiblen672b58b2017-02-21 14:32:53 -07005002 return skip;
5003}