blob: 8676ddaf060465ae368e3a3089d7707c5bd3a4c3 [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 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600294 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700295 }
296 }
297}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600298// Set image layout for given VkImageSubresourceLayers struct
299void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
300 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
301 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
302 VkImageSubresourceRange image_subresource_range;
303 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
304 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
305 image_subresource_range.layerCount = image_subresource_layers.layerCount;
306 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
307 image_subresource_range.levelCount = 1;
308 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
309}
Dave Houltonddd65c52018-05-08 14:58:01 -0600310
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600311// Set image layout for all slices of an image view
John Zulauf4ccf5c02018-09-21 11:46:18 -0600312void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_VIEW_STATE *view_state,
313 const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600314 assert(view_state);
315
Dave Houltonddd65c52018-05-08 14:58:01 -0600316 IMAGE_STATE *image_state = GetImageState(device_data, view_state->create_info.image);
317 VkImageSubresourceRange sub_range = view_state->create_info.subresourceRange;
318
319 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
320 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
321 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state->create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
322 sub_range.baseArrayLayer = 0;
323 sub_range.layerCount = image_state->createInfo.extent.depth;
324 }
325
326 SetImageLayout(device_data, cb_node, image_state, sub_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600327}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700328
John Zulauf4ccf5c02018-09-21 11:46:18 -0600329void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
330 auto view_state = GetImageViewState(device_data, imageView);
331 SetImageViewLayout(device_data, cb_node, view_state, layout);
332}
333
Tobias Hectorbbb12282018-10-22 15:17:59 +0100334bool ValidateRenderPassLayoutAgainstFramebufferImageUsage(layer_data *device_data, RenderPassCreateVersion rp_version,
335 VkImageLayout layout, VkImage image, VkImageView image_view,
336 VkFramebuffer framebuffer, VkRenderPass renderpass,
337 uint32_t attachment_index, const char *variable_name) {
338 bool skip = false;
339 const auto report_data = core_validation::GetReportData(device_data);
340 auto image_state = GetImageState(device_data, image);
341 const char *vuid;
342 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
343
344 if (!image_state) {
345 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
346 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
347 "Render Pass begin with renderpass 0x%" PRIx64 " uses framebuffer 0x%" PRIx64 " where pAttachments[%" PRIu32
348 "] = image view 0x%" PRIx64 ", which refers to an invalid image",
349 HandleToUint64(renderpass), HandleToUint64(framebuffer), attachment_index, HandleToUint64(image_view));
350 return skip;
351 }
352
353 auto image_usage = image_state->createInfo.usage;
354
355 // Check for layouts that mismatch image usages in the framebuffer
356 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
357 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
358 skip |=
359 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
360 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
361 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
362 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
363 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
364 HandleToUint64(renderpass), HandleToUint64(image_view));
365 }
366
367 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
368 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
369 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
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_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_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_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
380 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
381 skip |=
382 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
383 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
384 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
385 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
386 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
387 HandleToUint64(renderpass), HandleToUint64(image_view));
388 }
389
390 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
391 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
392 skip |=
393 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
394 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
395 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
396 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
397 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
398 HandleToUint64(renderpass), HandleToUint64(image_view));
399 }
400
401 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
402 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
403 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
404 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
405 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
406 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
407 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
408 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
409 HandleToUint64(image), vuid,
410 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
411 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
412 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
413 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
414 HandleToUint64(renderpass), HandleToUint64(image_view));
415 }
416 } else {
417 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
418 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
419 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
420 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
421 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
422 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
423 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
424 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
425 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
426 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
427 HandleToUint64(renderpass), HandleToUint64(image_view));
428 }
429 }
430 return skip;
431}
432
433bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700434 const VkRenderPassBeginInfo *pRenderPassBegin,
435 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600436 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700437 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700438 auto const &framebufferInfo = framebuffer_state->createInfo;
439 const auto report_data = core_validation::GetReportData(device_data);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100440
441 auto render_pass = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->renderPass;
442 auto framebuffer = framebuffer_state->framebuffer;
443
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700444 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600445 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 -0600446 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700447 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700448 }
449 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
450 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700451 auto view_state = GetImageViewState(device_data, image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600452
453 if (!view_state) {
454 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
455 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
456 "vkCmdBeginRenderPass() :framebuffer 0x%" PRIx64 " pAttachments[%" PRIu32 "] = 0x%" PRIx64
457 " is not a valid VkImageView handle",
458 HandleToUint64(framebuffer_state->framebuffer), i, HandleToUint64(image_view));
459 continue;
460 }
461
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700462 const VkImage &image = view_state->create_info.image;
463 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700464 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100465 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
466
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700467 // TODO: Do not iterate over every possibility - consolidate where possible
468 for (uint32_t j = 0; j < subRange.levelCount; j++) {
469 uint32_t level = subRange.baseMipLevel + j;
470 for (uint32_t k = 0; k < subRange.layerCount; k++) {
471 uint32_t layer = subRange.baseArrayLayer + k;
472 VkImageSubresource sub = {subRange.aspectMask, level, layer};
473 IMAGE_CMD_BUF_LAYOUT_NODE node;
474 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700475 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700476 continue;
477 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700478 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600479 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 -0600480 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700481 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
482 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
483 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600484 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700485 }
486 }
487 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100488
489 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, initial_layout, image, image_view,
490 framebuffer, render_pass, i, "initial layout");
491
492 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, final_layout, image, image_view, framebuffer,
493 render_pass, i, "final layout");
494 }
495
496 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
497 auto &subpass = pRenderPassInfo->pSubpasses[j];
498 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
499 auto &attachment_ref = subpass.pInputAttachments[k];
500 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
501 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
502 auto view_state = GetImageViewState(device_data, image_view);
503
504 if (view_state) {
505 auto image = view_state->create_info.image;
506 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
507 image_view, framebuffer, render_pass,
508 attachment_ref.attachment, "input attachment layout");
509 }
510 }
511 }
512
513 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
514 auto &attachment_ref = subpass.pColorAttachments[k];
515 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
516 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
517 auto view_state = GetImageViewState(device_data, image_view);
518
519 if (view_state) {
520 auto image = view_state->create_info.image;
521 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
522 image_view, framebuffer, render_pass,
523 attachment_ref.attachment, "color attachment layout");
524 if (subpass.pResolveAttachments) {
525 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
526 device_data, rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
527 attachment_ref.attachment, "resolve attachment layout");
528 }
529 }
530 }
531 }
532
533 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
534 auto &attachment_ref = *subpass.pDepthStencilAttachment;
535 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
536 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
537 auto view_state = GetImageViewState(device_data, image_view);
538
539 if (view_state) {
540 auto image = view_state->create_info.image;
541 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
542 image_view, framebuffer, render_pass,
543 attachment_ref.attachment, "input attachment layout");
544 }
545 }
546 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700547 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600548 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700549}
550
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700551void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Tobias Hectorbbb12282018-10-22 15:17:59 +0100552 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700553 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf8e308292018-09-21 11:34:37 -0600554 auto image_view = GetAttachmentImageViewState(device_data, pFramebuffer, ref.attachment);
555 if (image_view) {
556 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
557 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700558 }
559}
560
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700561void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700562 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700563 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700564
565 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700566 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700567 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
568 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
569 }
570 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
571 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
572 }
573 if (subpass.pDepthStencilAttachment) {
574 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
575 }
576 }
577}
578
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600579bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700580 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700581 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
582 return false;
583 }
584 VkImageSubresource sub = {aspect, level, layer};
585 IMAGE_CMD_BUF_LAYOUT_NODE node;
586 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700587 return false;
588 }
589 bool skip = false;
590 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
591 // TODO: Set memory invalid which is in mem_tracker currently
592 } else if (node.layout != mem_barrier->oldLayout) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600593 skip = log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
594 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
595 "VUID-VkImageMemoryBarrier-oldLayout-01197",
596 "For image 0x%" PRIx64
597 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
598 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
599 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700600 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700601 return skip;
602}
603
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700604// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
605// 1. Transition into initialLayout state
606// 2. Transition from initialLayout to layout used in subpass 0
607void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
608 FRAMEBUFFER_STATE *framebuffer_state) {
609 // First transition into initialLayout
610 auto const rpci = render_pass_state->createInfo.ptr();
611 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -0600612 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
613 if (view_state) {
614 SetImageViewLayout(device_data, cb_state, view_state, rpci->pAttachments[i].initialLayout);
615 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700616 }
617 // Now transition for first subpass (index 0)
618 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
619}
620
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700621void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
Tony-LunarG0d27b302018-10-08 09:26:21 -0600622 uint32_t level, uint32_t layer, VkImageAspectFlags aspect_mask, VkImageAspectFlags aspect) {
623 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700624 return;
625 }
626 VkImageSubresource sub = {aspect, level, layer};
627 IMAGE_CMD_BUF_LAYOUT_NODE node;
628 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700629 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700630 SetLayout(device_data, pCB, mem_barrier->image, sub,
631 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
632 return;
633 }
634 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
635 // TODO: Set memory invalid
636 }
637 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
638}
639
Dave Houlton10b39482017-03-16 13:18:15 -0600640bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600641 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600642 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600643 }
644 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600645 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600646 }
647 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600648 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600649 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700650 if (0 !=
651 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
652 if (FormatPlaneCount(format) == 1) return false;
653 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600654 return true;
655}
656
Mike Weiblen62d08a32017-03-07 22:18:27 -0700657// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
658bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
659 VkImageUsageFlags usage_flags, const char *func_name) {
660 const auto report_data = core_validation::GetReportData(device_data);
661 bool skip = false;
662 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Dave Houlton8e9f6542018-05-18 12:18:22 -0600663 std::string msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700664
665 switch (layout) {
666 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
667 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600668 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700669 }
670 break;
671 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
672 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600673 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700674 }
675 break;
676 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
677 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600678 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700679 }
680 break;
681 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
682 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600683 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684 }
685 break;
686 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
687 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600688 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700689 }
690 break;
691 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
692 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600693 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700694 }
695 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600696 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500697 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
698 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
699 }
700 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700701 default:
702 // Other VkImageLayout values do not have VUs defined in this context.
703 break;
704 }
705
Dave Houlton8e9f6542018-05-18 12:18:22 -0600706 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600707 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 -0600708 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600709 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
710 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
711 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700712 }
713 return skip;
714}
715
John Zulauf463c51e2018-05-31 13:29:20 -0600716// Scoreboard for checking for duplicate and inconsistent barriers to images
717struct ImageBarrierScoreboardEntry {
718 uint32_t index;
719 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
720 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
721 const VkImageMemoryBarrier *barrier;
722};
723using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
724using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
725
Mike Weiblen62d08a32017-03-07 22:18:27 -0700726// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600727bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700728 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700729 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700730
John Zulauf463c51e2018-05-31 13:29:20 -0600731 // Scoreboard for duplicate layout transition barriers within the list
732 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
733 ImageBarrierScoreboardImageMap layout_transitions;
734
Mike Weiblen62d08a32017-03-07 22:18:27 -0700735 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
736 auto img_barrier = &pImageMemoryBarriers[i];
737 if (!img_barrier) continue;
738
John Zulauf463c51e2018-05-31 13:29:20 -0600739 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
740 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
741 // at a per sub-resource level
742 if (img_barrier->oldLayout != img_barrier->newLayout) {
743 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
744 auto image_it = layout_transitions.find(img_barrier->image);
745 if (image_it != layout_transitions.end()) {
746 auto &subres_map = image_it->second;
747 auto subres_it = subres_map.find(img_barrier->subresourceRange);
748 if (subres_it != subres_map.end()) {
749 auto &entry = subres_it->second;
750 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
751 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
752 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
753 skip = log_msg(
754 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
755 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_state->commandBuffer),
756 "VUID-VkImageMemoryBarrier-oldLayout-01197",
757 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image 0x%" PRIx64
758 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
759 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
760 func_name, i, entry.index, HandleToUint64(img_barrier->image), range.aspectMask, range.baseMipLevel,
761 range.levelCount, range.baseArrayLayer, range.layerCount, string_VkImageLayout(img_barrier->oldLayout),
762 string_VkImageLayout(entry.barrier->newLayout));
763 }
764 entry = new_entry;
765 } else {
766 subres_map[img_barrier->subresourceRange] = new_entry;
767 }
768 } else {
769 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
770 }
771 }
772
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600773 auto image_state = GetImageState(device_data, img_barrier->image);
774 if (image_state) {
775 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
776 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
777 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
778
779 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
780 if (image_state->layout_locked) {
781 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600782 skip |= log_msg(
783 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Young9d1ac312018-05-21 16:28:27 -0600784 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100785 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600786 " 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 +0100787 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600788 string_VkImageLayout(img_barrier->newLayout));
789 }
790 }
791
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600792 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600793 // For a Depth/Stencil image both aspects MUST be set
794 if (FormatIsDepthAndStencil(image_create_info->format)) {
795 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
796 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
797 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600798 skip |=
799 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -0600800 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image),
801 "VUID-VkImageMemoryBarrier-image-01207",
Mark Lobodzinski88529492018-04-01 10:38:15 -0600802 "%s: Image barrier 0x%p references image 0x%" PRIx64
803 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
804 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
805 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600806 }
807 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600808 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
809 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700810
Mike Weiblen62d08a32017-03-07 22:18:27 -0700811 for (uint32_t j = 0; j < level_count; j++) {
812 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
813 for (uint32_t k = 0; k < layer_count; k++) {
814 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600815 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
816 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
817 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
818 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700819 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
820 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
821 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
822 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
823 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
824 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
825 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
826 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700827 }
828 }
829 }
830 return skip;
831}
832
Chris Forbes4de4b132017-08-21 11:27:08 -0700833static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600834 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700835
836 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600837 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700838}
839
John Zulauf6b4aae82018-05-09 13:03:36 -0600840template <typename Barrier>
841bool ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
842 uint32_t barrier_count, const Barrier *barriers) {
843 using BarrierRecord = QFOTransferBarrier<Barrier>;
844 bool skip = false;
845 const auto report_data = core_validation::GetReportData(device_data);
846 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
847 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
848 const char *barrier_name = BarrierRecord::BarrierName();
849 const char *handle_name = BarrierRecord::HandleName();
850 const char *transfer_type = nullptr;
851 for (uint32_t b = 0; b < barrier_count; b++) {
852 if (!IsTransferOp(&barriers[b])) continue;
853 const BarrierRecord *barrier_record = nullptr;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600854 if (IsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600855 const auto found = barrier_sets.release.find(barriers[b]);
856 if (found != barrier_sets.release.cend()) {
857 barrier_record = &(*found);
858 transfer_type = "releasing";
859 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600860 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
861 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600862 const auto found = barrier_sets.acquire.find(barriers[b]);
863 if (found != barrier_sets.acquire.cend()) {
864 barrier_record = &(*found);
865 transfer_type = "acquiring";
866 }
867 }
868 if (barrier_record != nullptr) {
869 skip |=
870 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
871 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
872 "%s: %s at index %" PRIu32 " %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
873 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
874 func_name, barrier_name, b, transfer_type, handle_name, HandleToUint64(barrier_record->handle),
875 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
876 }
877 }
878 return skip;
879}
880
881template <typename Barrier>
882void RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
883 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
884 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
885 for (uint32_t b = 0; b < barrier_count; b++) {
886 if (!IsTransferOp(&barriers[b])) continue;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600887 if (IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600888 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600889 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
890 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600891 barrier_sets.acquire.emplace(barriers[b]);
892 }
893 }
894}
895
896bool ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
897 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
898 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
899 bool skip = false;
900 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
901 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
902 return skip;
903}
904
905void RecordBarriersQFOTransfers(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
906 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
907 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
908 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
909 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
910}
911
912template <typename BarrierRecord, typename Scoreboard>
913static bool ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
914 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
915 // Record to the scoreboard or report that we have a duplication
916 bool skip = false;
917 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
918 if (!inserted.second && inserted.first->second != cb_state) {
919 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
920 skip = log_msg(
921 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
922 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
923 "%s: %s %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
924 " duplicates existing barrier submitted in this batch from command buffer 0x%" PRIx64 ".",
925 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(), HandleToUint64(barrier.handle),
926 barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex, HandleToUint64(inserted.first->second));
927 }
928 return skip;
929}
930
931template <typename Barrier>
932static bool ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
933 QFOTransferCBScoreboards<Barrier> *scoreboards) {
934 using BarrierRecord = QFOTransferBarrier<Barrier>;
935 using TypeTag = typename BarrierRecord::Tag;
936 bool skip = false;
937 const auto report_data = core_validation::GetReportData(device_data);
938 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
939 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
940 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
941 const char *barrier_name = BarrierRecord::BarrierName();
942 const char *handle_name = BarrierRecord::HandleName();
943 // No release should have an extant duplicate (WARNING)
944 for (const auto &release : cb_barriers.release) {
945 // Check the global pending release barriers
946 const auto set_it = global_release_barriers.find(release.handle);
947 if (set_it != global_release_barriers.cend()) {
948 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
949 const auto found = set_for_handle.find(release);
950 if (found != set_for_handle.cend()) {
951 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
952 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
953 "%s: %s releasing queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
954 " to dstQueueFamilyIndex %" PRIu32
955 " duplicates existing barrier queued for execution, without intervening acquire operation.",
956 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(found->handle),
957 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
958 }
959 }
960 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
961 }
962 // Each acquire must have a matching release (ERROR)
963 for (const auto &acquire : cb_barriers.acquire) {
964 const auto set_it = global_release_barriers.find(acquire.handle);
965 bool matching_release_found = false;
966 if (set_it != global_release_barriers.cend()) {
967 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
968 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
969 }
970 if (!matching_release_found) {
971 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
972 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Petr Krausfd505102018-12-17 15:18:01 +0100973 "%s: in submitted command buffer %s acquiring ownership of %s (0x%" PRIx64
John Zulauf6b4aae82018-05-09 13:03:36 -0600974 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
975 " has no matching release barrier queued for execution.",
976 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(acquire.handle),
977 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
978 }
979 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
980 }
981 return skip;
982}
983
984bool ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
985 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
986 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
987 bool skip = false;
988 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
989 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
990 return skip;
991}
992
993template <typename Barrier>
994static void RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
995 using BarrierRecord = QFOTransferBarrier<Barrier>;
996 using TypeTag = typename BarrierRecord::Tag;
997 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
998 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
999 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
1000
1001 // Add release barriers from this submit to the global map
1002 for (const auto &release : cb_barriers.release) {
1003 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1004 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1005 global_release_barriers[release.handle].insert(release);
1006 }
1007
1008 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1009 for (const auto &acquire : cb_barriers.acquire) {
1010 // NOTE: We're not using [] because we don't want to create entries for missing releases
1011 auto set_it = global_release_barriers.find(acquire.handle);
1012 if (set_it != global_release_barriers.end()) {
1013 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1014 set_for_handle.erase(acquire);
1015 if (set_for_handle.size() == 0) { // Clean up empty sets
1016 global_release_barriers.erase(set_it);
1017 }
1018 }
1019 }
1020}
1021
1022void RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1023 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1024 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1025}
1026
1027// Remove the pending QFO release records from the global set
1028// Note that the type of the handle argument constrained to match Barrier type
1029// The defaulted BarrierRecord argument allows use to declare the type once, but is not intended to be specified by the caller
1030template <typename Barrier, typename BarrierRecord = QFOTransferBarrier<Barrier>>
1031static void EraseQFOReleaseBarriers(layer_data *device_data, const typename BarrierRecord::HandleType &handle) {
1032 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1033 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, typename BarrierRecord::Tag());
1034 global_release_barriers.erase(handle);
1035}
1036
1037// Avoid making the template globally visible by exporting the one instance of it we need.
1038void EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
1039 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1040}
1041
Chris Forbes399a6782017-08-18 15:00:48 -07001042void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001043 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001044 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1045 auto mem_barrier = &pImgMemBarriers[i];
1046 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001047
Chris Forbes4de4b132017-08-21 11:27:08 -07001048 // For ownership transfers, the barrier is specified twice; as a release
1049 // operation on the yielding queue family, and as an acquire operation
1050 // on the acquiring queue family. This barrier may also include a layout
1051 // transition, which occurs 'between' the two operations. For validation
1052 // purposes it doesn't seem important which side performs the layout
1053 // transition, but it must not be performed twice. We'll arbitrarily
1054 // choose to perform it as part of the acquire operation.
1055 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
1056 continue;
1057 }
1058
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001059 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
1060 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1061 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1062
Dave Houltonb3f4b282018-02-22 16:25:16 -07001063 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1064 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1065 // for all (potential) layer sub_resources.
1066 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1067 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1068 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1069 }
1070
Tony-LunarG0d27b302018-10-08 09:26:21 -06001071 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1072 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
1073 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1074 if (FormatIsMultiplane(image_create_info->format)) {
1075 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1076 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1077 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1078 if (FormatPlaneCount(image_create_info->format) > 2) {
1079 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1080 }
1081 }
1082 }
1083 }
1084
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001085 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001086 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001087 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001088 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Tony-LunarG0d27b302018-10-08 09:26:21 -06001089 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1090 VK_IMAGE_ASPECT_COLOR_BIT);
1091 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1092 VK_IMAGE_ASPECT_DEPTH_BIT);
1093 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1094 VK_IMAGE_ASPECT_STENCIL_BIT);
1095 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1096 VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001097 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001098 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1099 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1100 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1101 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1102 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1103 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001104 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001105 }
1106 }
1107 }
1108}
1109
Tobin Ehlisc8266452017-04-07 12:20:30 -06001110bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001111 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07001112 const char *caller, const std::string &layout_invalid_msg_code, const std::string &layout_mismatch_msg_code,
1113 bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001114 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001115 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001116 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001117
1118 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1119 uint32_t layer = i + subLayers.baseArrayLayer;
1120 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1121 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001122 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1123 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001124 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001125 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1126 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1127 "%s: Cannot use image 0x%" PRIx64
1128 " (layer=%u mip=%u) with specific layout %s that doesn't match the actual current layout %s.",
1129 caller, HandleToUint64(image), layer, subLayers.mipLevel, string_VkImageLayout(explicit_layout),
1130 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001131 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001132 }
1133 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001134 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1135 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1136 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001137 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1138 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001139 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001140 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001141 kVUID_Core_DrawState_InvalidImageLayout,
Petr Kraus13c98a62017-12-09 00:22:39 +01001142 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
1143 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001144 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001145 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001146 if (image_state->shared_presentable) {
1147 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001148 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1149 layout_invalid_msg_code,
1150 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1151 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001152 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001153 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001154 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001155 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001156 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 -07001157 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001158 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1159 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001160 }
1161 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001162 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001163}
1164
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001165void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
1166 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001167 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001168 if (!renderPass) return;
1169
Tobias Hectorbbb12282018-10-22 15:17:59 +01001170 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001171 if (framebuffer_state) {
1172 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -06001173 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
1174 if (view_state) {
1175 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
1176 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001177 }
1178 }
1179}
Dave Houltone19e20d2018-02-02 16:32:41 -07001180
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001181#ifdef VK_USE_PLATFORM_ANDROID_KHR
1182// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1183// This could also move into a seperate core_validation_android.cpp file... ?
1184
1185//
1186// AHB-specific validation within non-AHB APIs
1187//
1188bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1189 const VkImageCreateInfo *create_info) {
1190 bool skip = false;
1191
1192 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1193 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001194 if (0 != ext_fmt_android->externalFormat) {
1195 if (VK_FORMAT_UNDEFINED != create_info->format) {
1196 skip |=
1197 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1198 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001199 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001200 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1201 }
1202
1203 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1204 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1205 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001206 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001207 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1208 }
1209
1210 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1211 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1212 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001213 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001214 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1215 }
1216
1217 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1218 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1219 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001220 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001221 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1222 }
1223 }
1224
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001225 auto ahb_formats = GetAHBExternalFormatsSet(device_data);
1226 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1227 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1228 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001229 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001230 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1231 }
1232 }
1233
Dave Houltond9611312018-11-19 17:03:36 -07001234 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001235 if (VK_FORMAT_UNDEFINED == create_info->format) {
1236 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1237 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001238 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001239 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1240 }
1241 }
1242
1243 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1244 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1245 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001246 skip |=
1247 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1248 "VUID-VkImageCreateInfo-pNext-02393",
1249 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1250 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1251 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001252 }
1253
1254 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1255 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1256 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001257 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001258 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1259 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1260 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1261 }
1262
1263 if (create_info->format == VK_FORMAT_UNDEFINED) {
1264 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
1265 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1266 "VUID-VkImageCreateInfo-pNext-02395",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001267 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001268 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID does not include "
1269 "a chained VkExternalFormatANDROID struct, or the externalFormat member is non-zero.");
1270 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001271 }
1272 }
1273
1274 return skip;
1275}
1276
1277void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
1278 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1279 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1280 is_node->imported_ahb = true;
1281 }
1282}
1283
1284bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
1285 bool skip = false;
1286 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1287 const VkExternalFormatANDROID *ext_format_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1288 if (ext_format_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001289 if (VK_FORMAT_UNDEFINED != create_info->format) {
1290 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1291 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1292 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1293 "format member is %s.",
1294 string_VkFormat(create_info->format));
1295 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001296
Dave Houltond9611312018-11-19 17:03:36 -07001297 // Chain must include a compatible ycbcr conversion
1298 bool conv_found = false;
1299 uint64_t external_format = 0;
1300 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1301 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001302 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
1303 auto fmap = GetYcbcrConversionFormatMap(device_data);
Dave Houltond9611312018-11-19 17:03:36 -07001304 if (fmap->find(conv_handle) != fmap->end()) {
1305 conv_found = true;
1306 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001307 }
Dave Houltond9611312018-11-19 17:03:36 -07001308 }
1309 if ((!conv_found) || (external_format != ext_format_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001310 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 -07001311 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1312 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1313 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1314 }
1315
1316 // Errors in create_info swizzles
1317 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1318 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1319 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1320 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1321 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1322 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1323 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1324 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001325 }
1326 }
Dave Houltond9611312018-11-19 17:03:36 -07001327
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001328 return skip;
1329}
1330
1331bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
1332 bool skip = false;
1333 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1334
1335 IMAGE_STATE *image_state = GetImageState(device_data, image);
1336 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1337 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1338 "VUID-vkGetImageSubresourceLayout-image-01895",
1339 "vkGetImageSubresourceLayout: Attempt to query layout from an image created with "
1340 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1341 "bound to memory.");
1342 }
1343 return skip;
1344}
1345
1346#else
1347
1348bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1349 const VkImageCreateInfo *create_info) {
1350 return false;
1351}
1352
1353void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
1354
1355bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
1356
1357bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
1358
1359#endif // VK_USE_PLATFORM_ANDROID_KHR
1360
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001361bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001362 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001363 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001364 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1365
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001366 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1367 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1368 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1369 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1370 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1371 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001372 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001373 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001374 }
1375
Dave Houlton130c0212018-01-29 13:39:56 -07001376 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001377 skip |= log_msg(
1378 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1379 "VUID-VkImageCreateInfo-flags-00949",
1380 "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 -07001381 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001382
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001383 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001384 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1385 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1386 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001387 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 +00001388 "VUID-VkImageCreateInfo-usage-00964",
1389 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1390 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001391 }
1392
1393 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001394 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 +00001395 "VUID-VkImageCreateInfo-usage-00965",
1396 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1397 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001398 }
1399
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001400 VkImageFormatProperties format_limits = {};
1401 VkResult res = GetPDImageFormatProperties(device_data, pCreateInfo, &format_limits);
1402 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1403 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1404 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1405 string_VkFormat(pCreateInfo->format));
1406 } else {
1407 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1408 const char *format_string = string_VkFormat(pCreateInfo->format);
1409 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1410 "VUID-VkImageCreateInfo-mipLevels-02255",
1411 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1412 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1413 }
Dave Houlton130c0212018-01-29 13:39:56 -07001414
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001415 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1416 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1417 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -07001418
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001419 // Round up to imageGranularity boundary
1420 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
1421 uint64_t ig_mask = imageGranularity - 1;
1422 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001423
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001424 if (total_size > format_limits.maxResourceSize) {
1425 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1426 kVUID_Core_Image_InvalidFormatLimitsViolation,
1427 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1428 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1429 total_size, format_limits.maxResourceSize);
1430 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001431
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001432 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1433 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1434 "VUID-VkImageCreateInfo-arrayLayers-02256",
1435 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1436 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1437 }
1438
1439 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1440 skip |=
1441 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1442 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001443 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001444 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001445 }
1446
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06001447 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) &&
1448 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001449 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 -06001450 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001451 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1452 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001453 }
1454
Lenny Komowb79f04a2017-09-18 17:07:00 -06001455 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1456 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1457 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1458 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1459 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001460 skip |=
1461 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1462 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1463 "format must be block, ETC or ASTC compressed, but is %s",
1464 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001465 }
1466 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1467 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001468 skip |=
1469 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1470 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1471 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001472 }
1473 }
1474 }
1475
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001476 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001477}
1478
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001479void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001480 IMAGE_LAYOUT_NODE image_state;
1481 image_state.layout = pCreateInfo->initialLayout;
1482 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001483 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
1484 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1485 RecordCreateImageANDROID(pCreateInfo, is_node);
1486 }
1487 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001488 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001489 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1490 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001491}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001492
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001493bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001494 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001495 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +02001496 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001497 if (disabled->destroy_image) return false;
1498 bool skip = false;
1499 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06001500 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001501 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001502 }
1503 return skip;
1504}
1505
John Zulauffca05c12018-04-26 16:30:39 -06001506void PreCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001507 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001508 // Clean up memory mapping, bindings and range references for image
1509 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001510 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001511 if (mem_info) {
1512 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1513 }
1514 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001515 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001516 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001517 // Remove image from imageMap
1518 core_validation::GetImageMap(device_data)->erase(image);
1519 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1520 core_validation::GetImageSubresourceMap(device_data);
1521
1522 const auto &sub_entry = imageSubresourceMap->find(image);
1523 if (sub_entry != imageSubresourceMap->end()) {
1524 for (const auto &pair : sub_entry->second) {
1525 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1526 }
1527 imageSubresourceMap->erase(sub_entry);
1528 }
1529}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001530
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001531bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001532 bool skip = false;
1533 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1534
1535 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1536 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1537 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 -06001538 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001539 }
1540
Dave Houlton1d2022c2017-03-29 11:43:58 -06001541 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001542 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1543 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 -06001544 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001545 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001546 char const str[] = "vkCmdClearColorImage called with compressed image.";
1547 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 -06001548 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001549 }
1550
1551 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1552 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1553 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 -06001554 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001555 }
1556 return skip;
1557}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001558
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001559uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1560 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1561 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001562 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001563 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001564 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001565 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001566}
1567
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001568uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1569 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1570 uint32_t array_layer_count = range->layerCount;
1571 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1572 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001573 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001574 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001575}
1576
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001577bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001578 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1579 bool skip = false;
1580 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1581
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001582 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1583 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001584
1585 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1586 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001587 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1588 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001589 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 -06001590 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001591 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1592 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001593 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001594 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001595 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001596 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 -06001597 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001598 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1599 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001600
1601 } else {
1602 if (image_state->shared_presentable) {
1603 skip |= log_msg(
1604 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001605 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001606 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1607 string_VkImageLayout(dest_image_layout));
1608 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001609 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001610 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001611 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001612 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001613 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001614 } else {
1615 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1616 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001617 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001618 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001619 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1620 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001621 }
1622 }
1623
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001624 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1625 uint32_t level = level_index + range.baseMipLevel;
1626 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1627 uint32_t layer = layer_index + range.baseArrayLayer;
1628 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001629 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001630 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001631 if (node.layout != dest_image_layout) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001632 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001633 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001634 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001635 } else {
1636 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1637 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001638 skip |=
1639 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1640 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1641 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001642 }
1643 }
1644 }
1645 }
1646
1647 return skip;
1648}
1649
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001650void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1651 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001652 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1653 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1654 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001655
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001656 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1657 uint32_t level = level_index + range.baseMipLevel;
1658 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1659 uint32_t layer = layer_index + range.baseArrayLayer;
1660 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001661 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001662 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1663 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 -07001664 }
1665 }
1666 }
1667}
1668
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001669bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001670 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1671 bool skip = false;
1672 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001673 auto cb_node = GetCBNode(dev_data, commandBuffer);
1674 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001675 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001676 skip |=
1677 ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001678 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001679 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001680 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001681 if (GetApiVersion(dev_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001682 skip |=
1683 ValidateImageFormatFeatureFlags(dev_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001684 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001685 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001686 skip |= InsideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001687 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001688 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001689 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001690 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001691 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001692 }
1693 }
1694 return skip;
1695}
1696
1697// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001698void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001699 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001700 auto cb_node = GetCBNode(dev_data, commandBuffer);
1701 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001702 if (cb_node && image_state) {
1703 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001704 for (uint32_t i = 0; i < rangeCount; ++i) {
1705 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1706 }
1707 }
1708}
1709
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001710bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1711 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001712 const VkImageSubresourceRange *pRanges) {
1713 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001714 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1715
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001716 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001717 auto cb_node = GetCBNode(device_data, commandBuffer);
1718 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001719 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001720 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1721 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001722 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001723 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001724 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001725 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1726 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001727 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1728 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001729 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001730 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001731 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001732 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001733 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001734 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001735 skip |=
1736 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001737 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001738 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1739 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001740 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001741 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1742 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001743 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 -06001744 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001745 }
1746 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001747 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001748 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001749 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 -06001750 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001751 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001752 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1753 char const str[] =
1754 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1755 "set.";
1756 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 -06001757 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001758 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001759 }
1760 return skip;
1761}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001762
1763// Returns true if [x, xoffset] and [y, yoffset] overlap
1764static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1765 bool result = false;
1766 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1767 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1768
1769 if (intersection_max > intersection_min) {
1770 result = true;
1771 }
1772 return result;
1773}
1774
Dave Houltonc991cc92018-03-06 11:08:51 -07001775// Returns true if source area of first copy region intersects dest area of second region
1776// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1777static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001778 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001779
Dave Houltonc991cc92018-03-06 11:08:51 -07001780 // Separate planes within a multiplane image cannot intersect
1781 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001782 return result;
1783 }
1784
Dave Houltonc991cc92018-03-06 11:08:51 -07001785 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1786 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1787 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001788 result = true;
1789 switch (type) {
1790 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001791 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001792 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001793 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001794 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001795 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001796 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001797 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001798 break;
1799 default:
1800 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1801 assert(false);
1802 }
1803 }
1804 return result;
1805}
1806
Dave Houltonfc1a4052017-04-27 14:32:45 -06001807// Returns non-zero if offset and extent exceed image extents
1808static const uint32_t x_bit = 1;
1809static const uint32_t y_bit = 2;
1810static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001811static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001812 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001813 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001814 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1815 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001816 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001817 }
1818 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1819 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001820 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001821 }
1822 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1823 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001824 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001825 }
1826 return result;
1827}
1828
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001829// Test if two VkExtent3D structs are equivalent
1830static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1831 bool result = true;
1832 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1833 (extent->depth != other_extent->depth)) {
1834 result = false;
1835 }
1836 return result;
1837}
1838
Dave Houltonee281a52017-12-08 13:51:02 -07001839// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1840// Destination image texel extents must be adjusted by block size for the dest validation checks
1841VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1842 VkExtent3D adjusted_extent = extent;
1843 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1844 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1845 adjusted_extent.width /= block_size.width;
1846 adjusted_extent.height /= block_size.height;
1847 adjusted_extent.depth /= block_size.depth;
1848 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1849 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1850 adjusted_extent.width *= block_size.width;
1851 adjusted_extent.height *= block_size.height;
1852 adjusted_extent.depth *= block_size.depth;
1853 }
1854 return adjusted_extent;
1855}
1856
Dave Houlton6f9059e2017-05-02 17:15:13 -06001857// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001858static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1859 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001860
1861 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001862 if (mip >= img->createInfo.mipLevels) {
1863 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001864 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001865
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001866 // 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 -06001867 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001868
1869 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1870 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001871 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001872 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1873 } else {
1874 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1875 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1876 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1877 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001878
Dave Houlton6f9059e2017-05-02 17:15:13 -06001879 // Image arrays have an effective z extent that isn't diminished by mip level
1880 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001881 extent.depth = img->createInfo.arrayLayers;
1882 }
1883
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001884 return extent;
1885}
1886
1887// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001888static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001889 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1890}
1891
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001892// Test if the extent argument has any dimensions set to 0.
1893static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1894 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1895}
1896
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001897// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1898static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1899 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1900 VkExtent3D granularity = {0, 0, 0};
1901 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1902 if (pPool) {
1903 granularity =
1904 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001905 if (FormatIsCompressed(img->createInfo.format)) {
1906 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001907 granularity.width *= block_size.width;
1908 granularity.height *= block_size.height;
1909 }
1910 }
1911 return granularity;
1912}
1913
1914// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1915static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1916 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001917 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1918 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001919 valid = false;
1920 }
1921 return valid;
1922}
1923
1924// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1925static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001926 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001927 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001928 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1929 bool skip = false;
1930 VkExtent3D offset_extent = {};
1931 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1932 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1933 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001934 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001935 // 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 -07001936 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001937 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 -04001938 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001939 "%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 "
1940 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001941 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001942 }
1943 } else {
1944 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1945 // integer multiples of the image transfer granularity.
1946 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001947 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 -04001948 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001949 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1950 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001951 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1952 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001953 }
1954 }
1955 return skip;
1956}
1957
1958// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1959static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1960 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001961 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001962 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001963 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1964 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001965 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001966 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1967 // subresource extent.
1968 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001969 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 -04001970 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001971 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1972 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1973 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1974 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001975 }
1976 } else {
1977 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1978 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1979 // subresource extent dimensions.
1980 VkExtent3D offset_extent_sum = {};
1981 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1982 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1983 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001984 bool x_ok = true;
1985 bool y_ok = true;
1986 bool z_ok = true;
1987 switch (image_type) {
1988 case VK_IMAGE_TYPE_3D:
1989 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1990 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001991 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001992 case VK_IMAGE_TYPE_2D:
1993 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1994 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001995 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001996 case VK_IMAGE_TYPE_1D:
1997 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1998 (subresource_extent->width == offset_extent_sum.width));
1999 break;
2000 default:
2001 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2002 assert(false);
2003 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002004 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002005 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 -04002006 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002007 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2008 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2009 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2010 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2011 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2012 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002013 }
2014 }
2015 return skip;
2016}
2017
Cort Strattonff1542a2018-05-27 10:49:28 -07002018bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
2019 const uint32_t i, const char *function, const char *member, const std::string &vuid) {
2020 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2021 bool skip = false;
2022 if (mip_level >= img->createInfo.mipLevels) {
2023 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2024 HandleToUint64(cb_node->commandBuffer), vuid,
2025 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
2026 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
2027 }
2028 return skip;
2029}
2030
2031bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2032 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
2033 const char *member, const std::string &vuid) {
2034 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2035 bool skip = false;
2036 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2037 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2038 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2039 HandleToUint64(cb_node->commandBuffer), vuid,
2040 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2041 "%u, but provided image %" PRIx64 " has %u array layers.",
2042 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
2043 }
2044 return skip;
2045}
2046
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002047// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002048bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2049 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Dave Houltone0969282018-05-23 15:54:31 -06002050 const uint32_t i, const char *function, const std::string &vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002051 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002052 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2053 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2054 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2055 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2056 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002057 return skip;
2058}
2059
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002060// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002061bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002062 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2063 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002064 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002065 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002066 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002067 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2068 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002069 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002070 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002071 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002072 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002073
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002074 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002075 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002076 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2077 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002078 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002079 const VkExtent3D dest_effective_extent =
2080 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002081 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002082 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002083 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002084 return skip;
2085}
2086
Dave Houlton6f9059e2017-05-02 17:15:13 -06002087// Validate contents of a VkImageCopy struct
2088bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
2089 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
2090 bool skip = false;
2091
2092 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002093 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002094
2095 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002096 const VkExtent3D src_copy_extent = region.extent;
2097 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002098 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2099
Dave Houlton6f9059e2017-05-02 17:15:13 -06002100 bool slice_override = false;
2101 uint32_t depth_slices = 0;
2102
2103 // Special case for copying between a 1D/2D array and a 3D image
2104 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2105 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002106 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002107 slice_override = (depth_slices != 1);
2108 } 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 -07002109 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002110 slice_override = (depth_slices != 1);
2111 }
2112
2113 // Do all checks on source image
2114 //
2115 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002116 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2117 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 -06002118 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002119 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002120 "be 0 and 1, respectively.",
2121 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002122 }
2123 }
2124
Dave Houlton533be9f2018-03-26 17:08:30 -06002125 // VUID-VkImageCopy-srcImage-01785
2126 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2127 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 -06002128 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002129 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002130 "these must be 0 and 1, respectively.",
2131 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002132 }
2133
Dave Houlton533be9f2018-03-26 17:08:30 -06002134 // VUID-VkImageCopy-srcImage-01787
2135 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2136 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 -06002137 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002138 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2139 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002140 }
2141
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002142 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002143 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002144 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002145 skip |=
2146 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002147 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002148 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002149 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2150 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002151 }
2152 }
2153 } else { // Pre maint 1
2154 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002155 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002156 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 -06002157 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002158 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2159 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002160 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2161 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002162 }
2163 }
2164 }
2165
Dave Houltonc991cc92018-03-06 11:08:51 -07002166 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2167 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
2168 if (FormatIsCompressed(src_state->createInfo.format) ||
2169 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002170 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002171 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002172 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2173 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2174 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002175 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002176 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 -07002177 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002178 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002179 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002180 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002181 }
2182
Dave Houlton94a00372017-12-14 15:08:47 -07002183 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002184 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2185 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002186 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002187 skip |=
2188 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002189 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002190 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002191 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002192 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002193 }
2194
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002195 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002196 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2197 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002198 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002199 skip |=
2200 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002201 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002202 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002203 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002204 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002205 }
2206
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002207 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002208 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2209 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002210 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002211 skip |=
2212 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002213 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002214 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002215 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002216 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002217 }
2218 } // Compressed
2219
2220 // Do all checks on dest image
2221 //
2222 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002223 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002224 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 -06002225 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002226 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002227 "these must be 0 and 1, respectively.",
2228 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002229 }
2230 }
2231
Dave Houlton533be9f2018-03-26 17:08:30 -06002232 // VUID-VkImageCopy-dstImage-01786
2233 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2234 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 -06002235 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002236 "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 -06002237 "and 1, respectively.",
2238 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002239 }
2240
2241 // VUID-VkImageCopy-dstImage-01788
2242 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2243 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 -06002244 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002245 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2246 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002247 }
2248
2249 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002250 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002251 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 -06002252 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002253 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002254 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2255 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002256 }
2257 }
2258 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002259 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002260 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002261 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002262 skip |=
2263 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002264 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002265 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002266 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2267 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002268 }
2269 }
2270 } else { // Pre maint 1
2271 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002272 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002273 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002274 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002275 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2276 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002277 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2278 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002279 }
2280 }
2281 }
2282
Dave Houltonc991cc92018-03-06 11:08:51 -07002283 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2284 if (FormatIsCompressed(dst_state->createInfo.format) ||
2285 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002286 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002287
2288 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002289 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2290 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2291 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002292 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002293 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 -07002294 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002296 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002297 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002298 }
2299
Dave Houlton94a00372017-12-14 15:08:47 -07002300 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002301 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2302 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002303 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002304 skip |=
2305 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002306 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002307 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002308 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002309 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002310 }
2311
Dave Houltonee281a52017-12-08 13:51:02 -07002312 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2313 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2314 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002315 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002316 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 -07002317 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002318 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2319 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002320 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002321 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002322 }
2323
Dave Houltonee281a52017-12-08 13:51:02 -07002324 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2325 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2326 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002327 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002328 skip |=
2329 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002330 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002331 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002332 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002333 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002334 }
2335 } // Compressed
2336 }
2337 return skip;
2338}
2339
Dave Houltonc991cc92018-03-06 11:08:51 -07002340// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2341bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2342 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2343 bool skip = false;
2344 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2345
2346 // Neither image is multiplane
2347 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2348 // If neither image is multi-plane the aspectMask member of src and dst must match
2349 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2350 std::stringstream ss;
2351 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
2352 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2353 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 -06002354 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002355 }
2356 } else {
2357 // Source image multiplane checks
2358 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2359 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2360 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2361 std::stringstream ss;
2362 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2363 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 -06002364 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002365 }
2366 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2367 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2368 std::stringstream ss;
2369 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2370 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 -06002371 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002372 }
2373 // Single-plane to multi-plane
2374 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2375 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2376 std::stringstream ss;
2377 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2378 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002379 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002380 }
2381
2382 // Dest image multiplane checks
2383 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2384 aspect = region.dstSubresource.aspectMask;
2385 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2386 std::stringstream ss;
2387 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2388 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 -06002389 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002390 }
2391 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2392 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2393 std::stringstream ss;
2394 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2395 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 -06002396 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002397 }
2398 // Multi-plane to single-plane
2399 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2400 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2401 std::stringstream ss;
2402 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2403 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002404 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002405 }
2406 }
2407
2408 return skip;
2409}
2410
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002411bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002412 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2413 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002414 bool skip = false;
2415 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002416 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
2417
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002418 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2419
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002420 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002421 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002422
2423 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2424 VkExtent3D src_copy_extent = region.extent;
2425 VkExtent3D dst_copy_extent =
2426 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2427
Dave Houlton6f9059e2017-05-02 17:15:13 -06002428 bool slice_override = false;
2429 uint32_t depth_slices = 0;
2430
2431 // Special case for copying between a 1D/2D array and a 3D image
2432 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2433 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2434 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002435 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 slice_override = (depth_slices != 1);
2437 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2438 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002439 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002440 slice_override = (depth_slices != 1);
2441 }
2442
Cort Strattond619a302018-05-17 19:46:32 -07002443 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2444 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002445 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2446 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2447 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2448 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2449 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2450 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2451 "VUID-vkCmdCopyImage-srcSubresource-01698");
2452 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2453 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2454 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002455
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002456 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002457 // No chance of mismatch if we're overriding depth slice count
2458 if (!slice_override) {
2459 // The number of depth slices in srcSubresource and dstSubresource must match
2460 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2461 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002462 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2463 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002464 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002465 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2466 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002467 if (src_slices != dst_slices) {
2468 std::stringstream ss;
2469 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
2470 << "] do not match";
2471 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 -06002472 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002473 }
2474 }
2475 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002476 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002477 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002478 std::stringstream ss;
2479 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
2480 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002481 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 -06002482 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002483 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002484 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002485
Dave Houltonc991cc92018-03-06 11:08:51 -07002486 // Do multiplane-specific checks, if extension enabled
2487 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2488 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2489 }
2490
Dave Houltonf5217612018-02-02 16:18:52 -07002491 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2492 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2493 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2494 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
2495 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 -06002496 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002497 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002498 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002499
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002500 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002501 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002502 std::stringstream ss;
2503 ss << "vkCmdCopyImage: pRegion[" << i
2504 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2505 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 -06002506 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002507 }
2508
2509 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002510 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002511 std::stringstream ss;
2512 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2513 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 -06002514 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002515 }
2516
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002517 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2518 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2519 // 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 -07002520 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2521 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002522 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002523 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
2524 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2525 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2526 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002527 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 -06002528 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002529 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002530
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002531 // 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 -07002532 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2533 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002534 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002535 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2536 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2537 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2538 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002539 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 -06002540 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002541 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002542 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002543
Dave Houltonfc1a4052017-04-27 14:32:45 -06002544 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002545 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2546 if (slice_override) src_copy_extent.depth = depth_slices;
2547 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002548 if (extent_check & x_bit) {
2549 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 -06002550 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002551 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002552 "width [%1d].",
2553 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002554 }
2555
2556 if (extent_check & y_bit) {
2557 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 -06002558 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002559 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002560 "height [%1d].",
2561 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002562 }
2563 if (extent_check & z_bit) {
2564 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002565 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002566 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002567 "depth [%1d].",
2568 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002569 }
2570
Dave Houltonee281a52017-12-08 13:51:02 -07002571 // Adjust dest extent if necessary
2572 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2573 if (slice_override) dst_copy_extent.depth = depth_slices;
2574
2575 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002576 if (extent_check & x_bit) {
2577 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002578 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002579 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002580 "width [%1d].",
2581 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002582 }
2583 if (extent_check & y_bit) {
2584 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 -06002585 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002586 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002587 "height [%1d].",
2588 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002589 }
2590 if (extent_check & z_bit) {
2591 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 -06002592 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002593 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002594 "depth [%1d].",
2595 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002596 }
2597
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002598 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2599 // must not overlap in memory
2600 if (src_image_state->image == dst_image_state->image) {
2601 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002602 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2603 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002604 std::stringstream ss;
2605 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2606 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002607 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002608 }
2609 }
2610 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002611 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002612
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002613 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2614 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2615 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002616 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002617 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2618 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002619 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 -06002620 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002621 }
2622 } else {
Tony-LunarG7482ca92018-10-01 14:20:22 -06002623 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, region_count, regions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002624 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2625 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 -06002626 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002627 }
2628 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002629
Dave Houlton33c22b72017-02-28 13:16:02 -07002630 // Source and dest image sample counts must match
2631 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2632 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2633 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 -06002634 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002635 }
2636
Dave Houltond8ed0212018-05-16 17:18:24 -06002637 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2638 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002639 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002640 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2641 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2642 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2643 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002644 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002645 skip |=
2646 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002647 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002648 skip |=
2649 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002650 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002651 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002652 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002653 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2654 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002655 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002656 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002657 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07002658 const std::string invalid_src_layout_vuid =
2659 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2660 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2661 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2662 const std::string invalid_dst_layout_vuid =
2663 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2664 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2665 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002666 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002667 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002668 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2669 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002670 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002671 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2672 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002673 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2674 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002675 }
2676
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002677 return skip;
2678}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002679
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002680void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002681 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2682 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2683 // Make sure that all image slices are updated to correct layout
2684 for (uint32_t i = 0; i < region_count; ++i) {
2685 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2686 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2687 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002688 // Update bindings between images and cmd buffer
2689 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2690 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002691}
2692
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002693// Returns true if sub_rect is entirely contained within rect
2694static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2695 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2696 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2697 return false;
2698 return true;
2699}
2700
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002701bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2702 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002703 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002704 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2705
2706 bool skip = false;
2707 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002708 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002709 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002710 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002711 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002712 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002713 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2714 // 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 -07002715 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2716 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002717 skip |= log_msg(
2718 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002719 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002720 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2721 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2722 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002723 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002724 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002725 }
2726
2727 // Validate that attachment is in reference list of active subpass
2728 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002729 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2730 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002731 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002732
2733 for (uint32_t i = 0; i < attachmentCount; i++) {
2734 auto clear_desc = &pAttachments[i];
2735 VkImageView image_view = VK_NULL_HANDLE;
2736
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002737 if (0 == clear_desc->aspectMask) {
2738 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 -06002739 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002740 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2741 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 -06002742 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002743 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002744 if ((subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment != VK_ATTACHMENT_UNUSED) &&
2745 (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002746 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 -07002747 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2748 "vkCmdClearAttachments() color attachment index %d is not VK_ATTACHMENT_UNUSED and is out of "
2749 "range for active subpass %d.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002750 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002751 } else {
2752 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002753 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002754 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002755 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2756 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2757 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002758 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002759 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 -06002760 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002761 }
2762 } else { // Must be depth and/or stencil
2763 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2764 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002765 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002766 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002767 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002768 }
2769 if (!subpass_desc->pDepthStencilAttachment ||
2770 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2771 skip |= log_msg(
2772 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002773 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002774 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002775 } else {
2776 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2777 }
2778 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002779 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002780 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002781 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002782 // The rectangular region specified by a given element of pRects must be contained within the render area of
2783 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002784 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2785 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2786 skip |=
2787 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002788 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002789 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002790 "the current render pass instance.",
2791 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002792 }
2793 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002794 const auto local_rect =
2795 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002796 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002797 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002798 return log_msg(
2799 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002800 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002801 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002802 "the current render pass instance.",
2803 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002804 }
2805 return false;
2806 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002807 }
2808 // The layers specified by a given element of pRects must be contained within every attachment that
2809 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002810 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002811 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2812 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002813 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 -06002814 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00017",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002815 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002816 "of pAttachment[%d].",
2817 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002818 }
2819 }
2820 }
2821 }
2822 }
2823 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002824}
2825
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002826bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Cort Stratton7df30962018-05-17 19:45:57 -07002827 VkImageLayout src_image_layout, IMAGE_STATE *dst_image_state, VkImageLayout dst_image_layout,
2828 uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002829 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002830 bool skip = false;
2831 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002832 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2833 "VUID-vkCmdResolveImage-srcImage-00256");
2834 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2835 "VUID-vkCmdResolveImage-dstImage-00258");
2836 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2837 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002838 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002839 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002840 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002841 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2842 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002843
Cort Stratton7df30962018-05-17 19:45:57 -07002844 bool hit_error = false;
2845 const std::string invalid_src_layout_vuid =
2846 (src_image_state->shared_presentable &&
2847 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2848 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2849 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2850 const std::string invalid_dst_layout_vuid =
2851 (dst_image_state->shared_presentable &&
2852 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2853 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2854 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002855 // For each region, the number of layers in the image subresource should not be zero
2856 // For each region, src and dest image aspect must be color only
2857 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002858 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2859 "srcSubresource", i);
2860 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2861 "dstSubresource", i);
Cort Stratton7df30962018-05-17 19:45:57 -07002862 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, src_image_layout,
2863 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2864 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
2865 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dst_image_layout,
2866 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2867 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002868 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2869 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2870 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2871 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2872 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2873 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2874 "VUID-vkCmdResolveImage-srcSubresource-01711");
2875 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2876 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2877 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002878
2879 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002880 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2881 skip |= log_msg(
2882 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002883 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002884 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002885 }
Cort Stratton7df30962018-05-17 19:45:57 -07002886 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002887 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2888 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2889 char const str[] =
2890 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2891 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 -06002892 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002893 }
2894 }
2895
2896 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2897 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002898 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 -06002899 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002900 }
2901 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2902 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002903 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 -06002904 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002905 }
2906 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2907 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2908 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 -06002909 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002910 }
2911 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2912 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2913 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 -06002914 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002915 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002916 } else {
2917 assert(0);
2918 }
2919 return skip;
2920}
2921
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002922void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2923 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002924 // Update bindings between images and cmd buffer
2925 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2926 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002927}
2928
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002929bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002930 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2931 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002932 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2933
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002934 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002935 if (cb_node) {
2936 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2937 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002938 if (cb_node && src_image_state && dst_image_state) {
2939 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002940 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002941 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002942 "VUID-vkCmdBlitImage-dstImage-00234");
2943 skip |=
2944 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2945 skip |=
2946 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
2947 skip |=
2948 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2949 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2950 skip |=
2951 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2952 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2953 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
2954 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002955 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002956 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002957 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002958 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04002959 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002960 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002961
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002962 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002963
Dave Houlton33c2d252017-06-09 17:08:32 -06002964 VkFormat src_format = src_image_state->createInfo.format;
2965 VkFormat dst_format = dst_image_state->createInfo.format;
2966 VkImageType src_type = src_image_state->createInfo.imageType;
2967 VkImageType dst_type = dst_image_state->createInfo.imageType;
2968
Cort Stratton186b1a22018-05-01 20:18:06 -04002969 if (VK_FILTER_LINEAR == filter) {
2970 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002971 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2972 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002973 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002974 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
2975 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002976 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002977 }
2978
2979 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2980 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002981 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002982 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002983 }
2984
Dave Houlton33c2d252017-06-09 17:08:32 -06002985 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2986 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2987 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 -06002988 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002989 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002990 }
2991
2992 // Validate consistency for unsigned formats
2993 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2994 std::stringstream ss;
2995 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2996 << "the other one must also have unsigned integer format. "
2997 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2998 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 -06002999 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003000 }
3001
3002 // Validate consistency for signed formats
3003 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3004 std::stringstream ss;
3005 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
3006 << "the other one must also have signed integer format. "
3007 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3008 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003009 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003010 }
3011
3012 // Validate filter for Depth/Stencil formats
3013 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3014 std::stringstream ss;
3015 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
3016 << "then filter must be VK_FILTER_NEAREST.";
3017 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003018 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003019 }
3020
3021 // Validate aspect bits and formats for depth/stencil images
3022 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3023 if (src_format != dst_format) {
3024 std::stringstream ss;
3025 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
3026 << "stencil, the other one must have exactly the same format. "
3027 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3028 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003029 skip |=
3030 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3031 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003032 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003033 } // Depth or Stencil
3034
3035 // Do per-region checks
Cort Stratton7df30962018-05-17 19:45:57 -07003036 const std::string invalid_src_layout_vuid =
3037 (src_image_state->shared_presentable &&
3038 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3039 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3040 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3041 const std::string invalid_dst_layout_vuid =
3042 (dst_image_state->shared_presentable &&
3043 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3044 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3045 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003046 for (uint32_t i = 0; i < region_count; i++) {
3047 const VkImageBlit rgn = regions[i];
3048 bool hit_error = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06003049 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003050 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3051 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Dave Houltond8ed0212018-05-16 17:18:24 -06003052 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003053 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3054 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003055 skip |=
3056 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3057 skip |=
3058 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003059 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3060 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3061 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3062 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3063 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3064 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3065 "VUID-vkCmdBlitImage-srcSubresource-01707");
3066 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3067 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3068 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003069 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003070 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3071 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003072 std::stringstream ss;
3073 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003074 skip |=
3075 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3076 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003077 }
Dave Houlton48989f32017-05-26 15:01:46 -06003078 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3079 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003080 std::stringstream ss;
3081 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003082 skip |=
3083 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3084 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003085 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003086
3087 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003088 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003089 skip |=
3090 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 -06003091 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003092 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003093 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003094
Dave Houlton48989f32017-05-26 15:01:46 -06003095 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003096 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 -06003097 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003098 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003099 }
Dave Houlton48989f32017-05-26 15:01:46 -06003100
Dave Houlton33c2d252017-06-09 17:08:32 -06003101 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3102 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 -06003103 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Dave Houlton33c2d252017-06-09 17:08:32 -06003104 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003105 "image format %s.",
3106 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003107 }
3108
3109 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3110 skip |= log_msg(
3111 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003112 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003113 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
3114 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003115 }
3116
Dave Houlton48989f32017-05-26 15:01:46 -06003117 // Validate source image offsets
3118 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003119 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003120 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
3121 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 -06003122 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
Dave Houlton48989f32017-05-26 15:01:46 -06003123 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003124 "of (%1d, %1d). These must be (0, 1).",
3125 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003126 }
3127 }
3128
Dave Houlton33c2d252017-06-09 17:08:32 -06003129 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003130 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3131 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 -06003132 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Dave Houlton48989f32017-05-26 15:01:46 -06003133 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003134 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3135 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003136 }
3137 }
3138
Dave Houlton33c2d252017-06-09 17:08:32 -06003139 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003140 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3141 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003142 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003143 skip |=
3144 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 -06003145 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003146 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3147 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003148 }
3149 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3150 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003151 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003152 skip |= log_msg(
3153 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003154 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003155 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
3156 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003157 }
3158 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3159 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003160 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003161 skip |=
3162 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 -06003163 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003164 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3165 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003166 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003167 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003168 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 -06003169 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003170 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003171 }
Dave Houlton48989f32017-05-26 15:01:46 -06003172
3173 // Validate dest image offsets
3174 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003175 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003176 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
3177 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003178 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
Dave Houlton48989f32017-05-26 15:01:46 -06003179 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003180 "(%1d, %1d). These must be (0, 1).",
3181 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003182 }
3183 }
3184
Dave Houlton33c2d252017-06-09 17:08:32 -06003185 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003186 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3187 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 -06003188 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Dave Houlton48989f32017-05-26 15:01:46 -06003189 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003190 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3191 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003192 }
3193 }
3194
Dave Houlton33c2d252017-06-09 17:08:32 -06003195 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003196 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3197 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003198 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003199 skip |=
3200 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 -06003201 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003202 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
3203 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003204 }
3205 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3206 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003207 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003208 skip |= log_msg(
3209 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003210 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003211 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
3212 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003213 }
3214 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3215 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003216 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003217 skip |=
3218 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 -06003219 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003220 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
3221 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003222 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003223 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003224 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 -06003225 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003226 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003227 }
3228
Dave Houlton33c2d252017-06-09 17:08:32 -06003229 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3230 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3231 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
3232 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 -06003233 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
Dave Houlton33c2d252017-06-09 17:08:32 -06003234 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003235 "layerCount other than 1.",
3236 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003237 }
3238 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003239 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003240 } else {
3241 assert(0);
3242 }
3243 return skip;
3244}
3245
Tobin Ehlis58c884f2017-02-08 12:15:27 -07003246void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003247 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
3248 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
3249 // Make sure that all image slices are updated to correct layout
3250 for (uint32_t i = 0; i < region_count; ++i) {
3251 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
3252 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
3253 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003254 // Update bindings between images and cmd buffer
3255 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3256 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003257}
3258
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003259// 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 -07003260bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003261 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3262 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003263 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07003264 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003265 for (auto cb_image_data : pCB->imageLayoutMap) {
3266 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003267
Dave Houltonb3f4b282018-02-22 16:25:16 -07003268 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3269 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003270 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3271 // TODO: Set memory invalid which is in mem_tracker currently
3272 } else if (imageLayout != cb_image_data.second.initialLayout) {
3273 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003274 skip |= log_msg(
3275 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003276 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003277 "Submitted command buffer expects image 0x%" PRIx64
3278 " (subresource: aspectMask 0x%X array layer %u, mip level %u) to be in layout %s--instead, image 0x%" PRIx64
3279 "'s current layout is %s.",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003280 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
3281 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003282 string_VkImageLayout(cb_image_data.second.initialLayout), HandleToUint64(cb_image_data.first.image),
3283 string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003284 } else {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003285 skip |=
3286 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3287 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3288 "Submitted command buffer expects image 0x%" PRIx64 " to be in layout %s--instead, image 0x%" PRIx64
3289 "'s current layout is %s.",
3290 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(cb_image_data.second.initialLayout),
3291 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003292 }
3293 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003294 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003295 }
3296 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003297 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003298}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003299
Tony Barbourdf013b92017-01-25 12:53:48 -07003300void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
3301 for (auto cb_image_data : pCB->imageLayoutMap) {
3302 VkImageLayout imageLayout;
3303 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3304 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3305 }
3306}
3307
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003308// Print readable FlagBits in FlagMask
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003309static std::string StringVkAccessFlags(VkAccessFlags accessMask) {
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003310 std::string result;
3311 std::string separator;
3312
3313 if (accessMask == 0) {
3314 result = "[None]";
3315 } else {
3316 result = "[";
3317 for (auto i = 0; i < 32; i++) {
3318 if (accessMask & (1 << i)) {
3319 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
3320 separator = " | ";
3321 }
3322 }
3323 result = result + "]";
3324 }
3325 return result;
3326}
3327
Dave Houlton12befb92018-06-26 17:16:46 -06003328#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 -06003329 // validation ToBeRemoved (disabled 6/18)
Dave Houlton12befb92018-06-26 17:16:46 -06003330
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003331// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
3332// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003333// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003334static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
3335 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
3336 const char *type) {
3337 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3338 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003339
3340 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
3341 if (accessMask & ~(required_bit | optional_bits)) {
3342 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003343 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 -06003344 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003345 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003346 StringVkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003347 }
3348 } else {
3349 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003350 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 -06003351 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003352 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
3353 "has previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003354 type, accessMask, StringVkAccessFlags(accessMask).c_str(), optional_bits,
3355 StringVkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003356 } else {
3357 std::string opt_bits;
3358 if (optional_bits != 0) {
3359 std::stringstream ss;
3360 ss << optional_bits;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003361 opt_bits = "and may have optional bits " + ss.str() + ' ' + StringVkAccessFlags(optional_bits);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003362 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003363 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 -06003364 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003365 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
3366 "previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003367 type, accessMask, StringVkAccessFlags(accessMask).c_str(), required_bit,
3368 StringVkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003369 }
3370 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003371 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003372}
Dave Houlton12befb92018-06-26 17:16:46 -06003373#endif
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003374
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003375// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003376// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3377// layout attachments don't have CLEAR as their loadOp.
Tobias Hectorbbb12282018-10-22 15:17:59 +01003378bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3379 const VkImageLayout first_layout, const uint32_t attachment,
3380 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003381 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003382 const char *vuid;
3383 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3384
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003385 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3386 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003387 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3388 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3389 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003390 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003391 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3392 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3393 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3394 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3395 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3396 skip |=
3397 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3398 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003399 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003400 }
3401 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003402 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3403 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003404 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003405 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003406 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 -06003407 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003408 }
3409 }
3410
3411 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3412 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003413 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003414 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003415 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 -06003416 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003417 }
3418 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003419 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003420}
3421
Tobias Hectorbbb12282018-10-22 15:17:59 +01003422bool ValidateLayouts(const core_validation::layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3423 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003424 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003425 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003426 const char *vuid;
3427 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3428 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003429
Jason Ekstranda1906302017-12-03 20:16:32 -08003430 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3431 VkFormat format = pCreateInfo->pAttachments[i].format;
3432 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3433 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3434 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003435 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 -06003436 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003437 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3438 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3439 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3440 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003441 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003442 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003443 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 -06003444 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003445 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3446 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3447 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3448 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003449 }
3450 }
3451 }
3452
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003453 // Track when we're observing the first use of an attachment
3454 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3455 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003456 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003457
3458 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3459 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3460 auto attach_index = subpass.pInputAttachments[j].attachment;
3461 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003462 switch (subpass.pInputAttachments[j].layout) {
3463 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3464 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3465 // These are ideal.
3466 break;
3467
3468 case VK_IMAGE_LAYOUT_GENERAL:
3469 // May not be optimal. TODO: reconsider this warning based on other constraints.
3470 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003471 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003472 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3473 break;
3474
Tobias Hectorbbb12282018-10-22 15:17:59 +01003475 case VK_IMAGE_LAYOUT_UNDEFINED:
3476 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3477 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3478 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3479 "Layout for input attachment reference %u in subpass %u is %s but must be "
3480 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3481 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3482 break;
3483
Graeme Leese668a9862018-10-08 10:40:02 +01003484 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3485 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3486 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3487 break;
3488 } else {
3489 // Intentionally fall through to generic error message
3490 }
3491 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003492
Cort Stratton7547f772017-05-04 15:18:52 -07003493 default:
3494 // No other layouts are acceptable
3495 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 -06003496 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003497 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3498 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3499 }
3500
Cort Stratton7547f772017-05-04 15:18:52 -07003501 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003502 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3503 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003504
3505 bool used_as_depth =
3506 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3507 bool used_as_color = false;
3508 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3509 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3510 }
3511 if (!used_as_depth && !used_as_color &&
3512 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003513 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3514 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3515 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3516 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003517 }
3518 }
3519 attach_first_use[attach_index] = false;
3520 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003521
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003522 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3523 auto attach_index = subpass.pColorAttachments[j].attachment;
3524 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3525
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003526 // TODO: Need a way to validate shared presentable images here, currently just allowing
3527 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3528 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003529 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003530 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003531 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003532 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3533 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003534 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003535
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003536 case VK_IMAGE_LAYOUT_GENERAL:
3537 // May not be optimal; TODO: reconsider this warning based on other constraints?
3538 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003539 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003540 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3541 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003542
Tobias Hectorbbb12282018-10-22 15:17:59 +01003543 case VK_IMAGE_LAYOUT_UNDEFINED:
3544 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3545 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3546 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3547 "Layout for color attachment reference %u in subpass %u is %s but should be "
3548 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3549 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3550 break;
3551
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003552 default:
3553 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 -06003554 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003555 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3556 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003557 }
3558
Tobias Hectorbbb12282018-10-22 15:17:59 +01003559 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3560 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
3561 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3562 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3563 "Layout for color attachment reference %u in subpass %u is %s but should be "
3564 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3565 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3566 }
3567
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003568 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003569 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3570 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003571 }
3572 attach_first_use[attach_index] = false;
3573 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003574
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003575 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3576 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003577 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3578 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3579 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003580 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003581
Dave Houltona9df0ce2018-02-07 10:51:23 -07003582 case VK_IMAGE_LAYOUT_GENERAL:
3583 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3584 // doing a bunch of transitions.
3585 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003586 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003587 "GENERAL layout for depth attachment may not give optimal performance.");
3588 break;
3589
Tobias Hectorbbb12282018-10-22 15:17:59 +01003590 case VK_IMAGE_LAYOUT_UNDEFINED:
3591 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3592 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3593 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3594 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3595 "layout or GENERAL.",
3596 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3597 break;
3598
Dave Houltona9df0ce2018-02-07 10:51:23 -07003599 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3600 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3601 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3602 break;
3603 } else {
3604 // Intentionally fall through to generic error message
3605 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003606 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003607
Dave Houltona9df0ce2018-02-07 10:51:23 -07003608 default:
3609 // No other layouts are acceptable
3610 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 -06003611 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003612 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3613 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3614 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003615 }
3616
3617 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3618 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003619 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3620 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003621 }
3622 attach_first_use[attach_index] = false;
3623 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003624 }
3625 return skip;
3626}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003627
3628// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003629bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3630 VkDeviceSize offset, VkDeviceSize end_offset) {
3631 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3632 bool skip = false;
3633 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3634 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003635 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3636 for (auto image_handle : mem_info->bound_images) {
3637 auto img_it = mem_info->bound_ranges.find(image_handle);
3638 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003639 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003640 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003641 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003642 for (auto layout : layouts) {
3643 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003644 skip |=
3645 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 -06003646 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003647 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3648 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003649 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003650 }
3651 }
3652 }
3653 }
3654 }
3655 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003656 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003657}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003658
3659// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3660// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003661static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3662 VulkanObjectType obj_type, std::string msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003663 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003664
3665 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003666 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003667 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003668 if (strict) {
3669 correct_usage = ((actual & desired) == desired);
3670 } else {
3671 correct_usage = ((actual & desired) != 0);
3672 }
3673 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003674 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003675 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003676 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003677 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 -06003678 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003679 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3680 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003681 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003682 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003683 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 -06003684 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3685 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003686 }
3687 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003688 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003689}
3690
3691// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3692// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003693bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003694 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003695 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3696 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003697}
3698
Cort Stratton186b1a22018-05-01 20:18:06 -04003699bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Dave Houltone0969282018-05-23 15:54:31 -06003700 char const *func_name, const std::string &linear_vuid, const std::string &optimal_vuid) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003701 VkFormatProperties format_properties = GetPDFormatProperties(dev_data, image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003702 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3703 bool skip = false;
3704 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3705 if ((format_properties.linearTilingFeatures & desired) != desired) {
3706 skip |=
3707 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3708 HandleToUint64(image_state->image), linear_vuid,
3709 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3710 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3711 }
3712 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3713 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3714 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3715 HandleToUint64(image_state->image), optimal_vuid,
3716 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3717 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3718 HandleToUint64(image_state->image));
3719 }
3720 }
3721 return skip;
3722}
3723
Cort Strattond619a302018-05-17 19:46:32 -07003724bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3725 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3726 uint32_t i) {
3727 bool skip = false;
3728 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3729 // layerCount must not be zero
3730 if (subresource_layers->layerCount == 0) {
3731 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3732 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3733 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3734 }
3735 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3736 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3737 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3738 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3739 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3740 }
3741 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3742 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3743 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3744 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3745 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3746 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3747 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3748 func_name, i, member);
3749 }
3750 return skip;
3751}
3752
Mark Lobodzinski96210742017-02-09 10:33:46 -07003753// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3754// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003755bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003756 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003757 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3758 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003759}
3760
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003761bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3762 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3763 bool skip = false;
3764 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3765
3766 const VkDeviceSize &range = pCreateInfo->range;
3767 if (range != VK_WHOLE_SIZE) {
3768 // Range must be greater than 0
3769 if (range <= 0) {
3770 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3771 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3772 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3773 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3774 range);
3775 }
3776 // Range must be a multiple of the element size of format
3777 const size_t format_size = FormatSize(pCreateInfo->format);
3778 if (range % format_size != 0) {
3779 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3780 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3781 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3782 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3783 "(" PRINTF_SIZE_T_SPECIFIER ").",
3784 range, format_size);
3785 }
3786 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3787 if (range / format_size > device_limits->maxTexelBufferElements) {
3788 skip |=
3789 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3790 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3791 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3792 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3793 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3794 range, format_size, device_limits->maxTexelBufferElements);
3795 }
3796 // The sum of range and offset must be less than or equal to the size of buffer
3797 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3798 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3799 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3800 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3801 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3802 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3803 range, pCreateInfo->offset, buffer_state->createInfo.size);
3804 }
3805 }
3806 return skip;
3807}
3808
Shannon McPherson265383a2018-06-21 15:37:52 -06003809bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3810 const VkBufferViewCreateInfo *pCreateInfo) {
3811 bool skip = false;
3812 const debug_report_data *report_data = GetReportData(device_data);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003813 const VkFormatProperties format_properties = GetPDFormatProperties(device_data, pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003814 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3815 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3816 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3817 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3818 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3819 "be supported for uniform texel buffers");
3820 }
3821 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3822 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3823 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3824 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3825 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3826 "be supported for storage texel buffers");
3827 }
3828 return skip;
3829}
3830
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003831bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003832 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003833 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3834
Dave Houltond8ed0212018-05-16 17:18:24 -06003835 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003836
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003837 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003838 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 -06003839 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003840 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003841 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003842 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003843
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003844 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3845 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003846 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 -06003847 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003848 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003849 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003850 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003851
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003852 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3853 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003854 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 -06003855 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003856 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003857 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003858 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003859 return skip;
3860}
3861
3862void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3863 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3864 GetBufferMap(device_data)
3865 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3866}
3867
Shannon McPhersona84241a2018-06-18 15:34:46 -06003868bool PreCallValidateCreateBufferView(const layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003869 bool skip = false;
Shannon McPherson883f6092018-06-14 13:15:25 -06003870 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003871 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003872 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3873 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003874 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3875 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003876 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3877 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003878 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3879 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3880 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3881 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003882
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003883 // Buffer view offset must be less than the size of buffer
3884 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3885 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3886 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3887 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3888 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3889 pCreateInfo->offset, buffer_state->createInfo.size);
3890 }
3891
Shannon McPherson883f6092018-06-14 13:15:25 -06003892 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
3893 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3894 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3895 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3896 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3897 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3898 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3899 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3900 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003901
3902 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003903
3904 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003905 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003906 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003907}
3908
3909void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3910 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3911}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003912
3913// For the given format verify that the aspect masks make sense
Tobias Hectorbbb12282018-10-22 15:17:59 +01003914bool ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3915 const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003916 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3917 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003918 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3919 if (image != VK_NULL_HANDLE) {
3920 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3921 }
3922
Dave Houlton1d2022c2017-03-29 11:43:58 -06003923 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003924 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003925 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003926 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003927 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003928 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003929 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003930 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003931 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003932 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003933 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003934 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003935 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3936 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003937 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003938 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003939 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003940 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3941 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003942 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003943 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003944 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003945 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003946 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003947 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003948 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003949 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003950 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003951 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003952 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003953 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003954 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003955 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003956 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003957 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003958 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003959 } else if (FormatIsMultiplane(format)) {
3960 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3961 if (3 == FormatPlaneCount(format)) {
3962 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3963 }
3964 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003965 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003966 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3967 "set, where n = [0, 1, 2].",
3968 func_name);
3969 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003970 }
3971 return skip;
3972}
3973
Petr Krausffa94af2017-08-08 21:46:02 +02003974struct SubresourceRangeErrorCodes {
Dave Houltond8ed0212018-05-16 17:18:24 -06003975 std::string base_mip_err, mip_count_err, base_layer_err, layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02003976};
3977
3978bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3979 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3980 const char *image_layer_count_var_name, const uint64_t image_handle,
3981 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003982 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3983 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003984
3985 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003986 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003987 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 -06003988 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003989 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003990 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3991 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003992 }
Petr Kraus4d718682017-05-18 03:38:41 +02003993
Petr Krausffa94af2017-08-08 21:46:02 +02003994 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3995 if (subresourceRange.levelCount == 0) {
3996 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 -06003997 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003998 } else {
3999 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004000
Petr Krausffa94af2017-08-08 21:46:02 +02004001 if (necessary_mip_count > image_mip_count) {
4002 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 -06004003 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004004 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004005 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004006 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004007 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004008 }
Petr Kraus4d718682017-05-18 03:38:41 +02004009 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004010 }
Petr Kraus4d718682017-05-18 03:38:41 +02004011
4012 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004013 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004014 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 -06004015 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004016 "%s: %s.baseArrayLayer (= %" PRIu32
4017 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4018 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004019 }
Petr Kraus4d718682017-05-18 03:38:41 +02004020
Petr Krausffa94af2017-08-08 21:46:02 +02004021 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4022 if (subresourceRange.layerCount == 0) {
4023 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 -06004024 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004025 } else {
4026 const uint64_t necessary_layer_count =
4027 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004028
Petr Krausffa94af2017-08-08 21:46:02 +02004029 if (necessary_layer_count > image_layer_count) {
4030 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 -06004031 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004032 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004033 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004034 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004035 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004036 }
Petr Kraus4d718682017-05-18 03:38:41 +02004037 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004038 }
Petr Kraus4d718682017-05-18 03:38:41 +02004039
Mark Lobodzinski602de982017-02-09 11:01:33 -07004040 return skip;
4041}
4042
Petr Krausffa94af2017-08-08 21:46:02 +02004043bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4044 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
4045 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
4046 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4047 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4048 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4049
4050 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4051 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4052
4053 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004054 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4055 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4056 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4057 : "VUID-VkImageViewCreateInfo-image-01482")
4058 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4059 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4060 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4061 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4062 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004063
4064 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4065 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4066 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4067}
4068
4069bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4070 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4071 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004072 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4073 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4074 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4075 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004076
4077 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4078 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4079 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4080}
4081
4082bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4083 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4084 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004085 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4086 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4087 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4088 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004089
4090 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4091 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4092 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4093}
4094
4095bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4096 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4097 const char *param_name) {
4098 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004099 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4100 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4101 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4102 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004103
4104 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4105 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4106 subresourceRangeErrorCodes);
4107}
4108
Mark Lobodzinski602de982017-02-09 11:01:33 -07004109bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
4110 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4111 bool skip = false;
4112 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
4113 if (image_state) {
4114 skip |= ValidateImageUsageFlags(
4115 device_data, image_state,
4116 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004117 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4118 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004119 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004120 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004121 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004122 skip |=
4123 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004124 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004125 skip |= ValidateCreateImageViewSubresourceRange(
4126 device_data, image_state,
4127 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4128 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004129
4130 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4131 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004132 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4133 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004134 VkFormat view_format = create_info->format;
4135 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004136 VkImageType image_type = image_state->createInfo.imageType;
4137 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004138
Dave Houltonbd2e2622018-04-10 16:41:14 -06004139 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
4140 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
4141 if (chained_ivuci_struct) {
4142 if (chained_ivuci_struct->usage & ~image_usage) {
4143 std::stringstream ss;
4144 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004145 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004146 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004147 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4148 HandleToUint64(create_info->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
4149 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004150 }
4151
4152 image_usage = chained_ivuci_struct->usage;
4153 }
4154
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004155 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4156 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004157 if (FormatIsMultiplane(image_format)) {
4158 // View format must match the multiplane compatible format
4159 uint32_t plane = 3; // invalid
4160 switch (aspect_mask) {
4161 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4162 plane = 0;
4163 break;
4164 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4165 plane = 1;
4166 break;
4167 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4168 plane = 2;
4169 break;
4170 default:
4171 break;
4172 }
4173
4174 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4175 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004176 std::stringstream ss;
4177 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004178 << " is not compatible with plane " << plane << " of underlying image format "
4179 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004180 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4181 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
4182 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004183 }
4184 } else {
4185 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
4186 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4187 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4188 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4189 std::stringstream ss;
4190 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
4191 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
4192 << ") format " << string_VkFormat(image_format)
4193 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4194 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004195 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4196 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
4197 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004198 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004199 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004200 }
4201 } else {
4202 // Format MUST be IDENTICAL to the format the image was created with
4203 if (image_format != view_format) {
4204 std::stringstream ss;
4205 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02004206 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004207 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004208 skip |=
4209 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4210 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004211 }
4212 }
4213
4214 // Validate correct image aspect bits for desired formats and format consistency
4215 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004216
4217 switch (image_type) {
4218 case VK_IMAGE_TYPE_1D:
4219 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004220 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4221 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004222 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4223 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004224 }
4225 break;
4226 case VK_IMAGE_TYPE_2D:
4227 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4228 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4229 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004230 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4231 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004232 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4233 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004234 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004235 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4236 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004237 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4238 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004239 }
4240 }
4241 break;
4242 case VK_IMAGE_TYPE_3D:
4243 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4244 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4245 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4246 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004247 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004248 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4249 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004250 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4251 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004252 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4253 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004254 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004255 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4256 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004257 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4258 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004259 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4260 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004261 }
4262 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004263 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4264 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004265 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4266 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004267 }
4268 }
4269 } else {
4270 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004271 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4272 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004273 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4274 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004275 }
4276 }
4277 break;
4278 default:
4279 break;
4280 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004281
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004282 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
4283 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
4284 skip |= ValidateCreateImageViewANDROID(device_data, create_info);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004285 }
4286
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004287 VkFormatProperties format_properties = GetPDFormatProperties(device_data, view_format);
4288 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4289 : format_properties.optimalTilingFeatures;
4290
4291 if (tiling_features == 0) {
4292 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4293 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-None-02273",
4294 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4295 "physical device.",
4296 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4297 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4298 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4299 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02274",
4300 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4301 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4302 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4303 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4304 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4305 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02275",
4306 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4307 "VK_IMAGE_USAGE_STORAGE_BIT.",
4308 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4309 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4310 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4311 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4312 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02276",
4313 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4314 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4315 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4316 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4317 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4318 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4319 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02277",
4320 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4321 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4322 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004323 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004324
Jeff Bolz9af91c52018-09-01 21:53:57 -05004325 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4326 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4327 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4328 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02086",
4329 "vkCreateImageView() If image was created with usage containing "
4330 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4331 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4332 }
4333 if (view_format != VK_FORMAT_R8_UINT) {
4334 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4335 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02087",
4336 "vkCreateImageView() If image was created with usage containing "
4337 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4338 }
4339 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004340 }
4341 return skip;
4342}
4343
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004344void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
4345 auto image_view_map = GetImageViewMap(device_data);
4346 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
4347
4348 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004349 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004350 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4351 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004352}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004353
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004354bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4355 BUFFER_STATE *dst_buffer_state) {
4356 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004357 skip |=
4358 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4359 skip |=
4360 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004361 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004362 skip |=
4363 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4364 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4365 skip |=
4366 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4367 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004368 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004369 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4370 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004371 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004372 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004373 return skip;
4374}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004375
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004376void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4377 BUFFER_STATE *dst_buffer_state) {
4378 // Update bindings between buffers and cmd buffer
4379 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4380 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004381}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004382
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004383static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004384 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4385 bool skip = false;
4386 auto buffer_state = GetBufferState(device_data, buffer);
4387 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004388 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 -06004389 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01004390 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004391 } else {
4392 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004393 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 -06004394 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004395 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004396 }
4397 }
4398 return skip;
4399}
4400
4401bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
4402 VK_OBJECT *obj_struct) {
4403 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004404 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004405 if (GetDisables(device_data)->destroy_image_view) return false;
4406 bool skip = false;
4407 if (*image_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004408 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView",
4409 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004410 }
4411 return skip;
4412}
4413
John Zulauffca05c12018-04-26 16:30:39 -06004414void PreCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
4415 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004416 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004417 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004418 (*GetImageViewMap(device_data)).erase(image_view);
4419}
4420
4421bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
4422 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02004423 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004424 if (GetDisables(device_data)->destroy_buffer) return false;
4425 bool skip = false;
4426 if (*buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004427 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004428 }
4429 return skip;
4430}
4431
John Zulauffca05c12018-04-26 16:30:39 -06004432void PreCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004433 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004434 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4435 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4436 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004437 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004438 }
4439 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004440 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004441 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004442 GetBufferMap(device_data)->erase(buffer_state->buffer);
4443}
4444
4445bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
4446 VK_OBJECT *obj_struct) {
4447 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004448 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004449 if (GetDisables(device_data)->destroy_buffer_view) return false;
4450 bool skip = false;
4451 if (*buffer_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004452 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView",
4453 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004454 }
4455 return skip;
4456}
4457
John Zulauffca05c12018-04-26 16:30:39 -06004458void PreCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
4459 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004460 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004461 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004462 GetBufferViewMap(device_data)->erase(buffer_view);
4463}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004464
4465bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
4466 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004467 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004468 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004469 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4470 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004471 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4472 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004473 skip |=
4474 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4475 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004476 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004477 return skip;
4478}
4479
4480void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004481 // Update bindings between buffer and cmd buffer
4482 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004483}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004484
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004485bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4486 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004487 bool skip = false;
4488
4489 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004490 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4491 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004492 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 -06004493 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004494 "%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 -06004495 "and 1, respectively.",
4496 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004497 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004498 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004499
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004500 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4501 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004502 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 -06004503 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004504 "%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 -06004505 "must be 0 and 1, respectively.",
4506 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004507 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004508 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004509
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004510 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4511 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004512 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 -06004513 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004514 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4515 "For 3D images these must be 0 and 1, respectively.",
4516 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004517 }
4518 }
4519
4520 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
4521 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06004522 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06004523 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004524 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 -06004525 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004526 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004527 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
4528 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004529 }
4530
4531 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004532 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004533 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 -06004534 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004535 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4536 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004537 }
4538
4539 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4540 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004541 skip |=
4542 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004543 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004544 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4545 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004546 }
4547
4548 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4549 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4550 skip |= log_msg(
4551 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004552 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004553 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4554 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004555 }
4556
4557 // subresource aspectMask must have exactly 1 bit set
4558 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4559 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4560 if (aspect_mask_bits.count() != 1) {
4561 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 -06004562 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004563 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004564 }
4565
4566 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004567 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004568 skip |= log_msg(
4569 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004570 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004571 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4572 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004573 }
4574
4575 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004576 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004577 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004578
4579 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004580 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004581 skip |= log_msg(
4582 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004583 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004584 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4585 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004586 }
4587
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004588 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004589 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004590 skip |= log_msg(
4591 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004592 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004593 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4594 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004595 }
4596
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004597 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004598 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4599 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4600 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004601 skip |=
4602 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004603 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004604 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4605 "width & height (%d, %d)..",
4606 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004607 }
4608
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004609 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004610 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
4611 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004612 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 -06004613 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004614 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4615 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
4616 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004617 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004618
4619 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004620 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004621 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004622 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4623 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 -06004624 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004625 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004626 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004627 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004628 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004629 }
4630
4631 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004632 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004633 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4634 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 -06004635 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004636 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004637 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004638 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004639 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004640 }
4641
4642 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004643 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004644 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4645 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 -06004646 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004647 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004648 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004649 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004650 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004651 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004652 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004653 }
4654
4655 return skip;
4656}
4657
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004658static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Dave Houltond8ed0212018-05-16 17:18:24 -06004659 const VkBufferImageCopy *pRegions, const char *func_name, std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004660 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004661 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004662
4663 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004664 VkExtent3D extent = pRegions[i].imageExtent;
4665 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004666
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004667 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4668 {
Dave Houlton51653902018-06-22 17:32:13 -06004669 skip |=
4670 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4671 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4672 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004673 }
4674
4675 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4676
4677 // 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 -06004678 if (FormatIsCompressed(image_info->format)) {
4679 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004680 if (image_extent.width % block_extent.width) {
4681 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4682 }
4683 if (image_extent.height % block_extent.height) {
4684 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4685 }
4686 if (image_extent.depth % block_extent.depth) {
4687 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4688 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004689 }
4690
Dave Houltonfc1a4052017-04-27 14:32:45 -06004691 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004692 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 -06004693 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004694 }
4695 }
4696
4697 return skip;
4698}
4699
Chris Forbese8ba09a2017-06-01 17:39:02 -07004700static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004701 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06004702 std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004703 bool skip = false;
4704
4705 VkDeviceSize buffer_size = buff_state->createInfo.size;
4706
4707 for (uint32_t i = 0; i < regionCount; i++) {
4708 VkExtent3D copy_extent = pRegions[i].imageExtent;
4709
4710 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4711 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004712 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004713
Dave Houltonf3229d52017-02-21 15:59:08 -07004714 // Handle special buffer packing rules for specific depth/stencil formats
4715 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004716 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004717 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4718 switch (image_state->createInfo.format) {
4719 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004720 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004721 break;
4722 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004723 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004724 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004725 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004726 case VK_FORMAT_D24_UNORM_S8_UINT:
4727 unit_size = 4;
4728 break;
4729 default:
4730 break;
4731 }
4732 }
4733
Tom Cooperb2550c72018-10-15 13:08:41 +01004734 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004735 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06004736 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004737 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4738 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4739
4740 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4741 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4742 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004743 }
4744
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004745 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4746 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4747 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004748 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004749 } else {
4750 // Calculate buffer offset of final copied byte, + 1.
4751 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4752 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4753 max_buffer_offset *= unit_size; // convert to bytes
4754 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004755
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004756 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004757 skip |=
4758 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4759 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004760 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004761 }
4762 }
4763
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004764 return skip;
4765}
4766
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004767bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004768 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004769 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004770 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4771 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4772
4773 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004774 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004775
4776 // Command pool must support graphics, compute, or transfer operations
4777 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4778
4779 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4780 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4781 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 -06004782 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004783 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004784 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004785 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004786 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004787 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004788 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004789 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004790
4791 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004792 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4793 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4794 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4795 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4796 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004797
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004798 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004799 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4800 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4801 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004802 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004803 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4804 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004805 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4806 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004807 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4808 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004809 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004810 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004811 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004812 const std::string src_invalid_layout_vuid =
4813 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4814 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4815 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004816 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004817 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4818 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004819 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004820 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4821 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004822 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004823 "vkCmdCopyImageToBuffer()",
4824 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004825 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4826 "vkCmdCopyImageToBuffer()", "imageSubresource",
4827 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4828 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4829 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4830 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004831 }
4832 return skip;
4833}
4834
4835void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004836 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4837 VkImageLayout src_image_layout) {
4838 // Make sure that all image slices are updated to correct layout
4839 for (uint32_t i = 0; i < region_count; ++i) {
4840 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4841 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004842 // Update bindings between buffer/image and cmd buffer
4843 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004844 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004845}
4846
4847bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004848 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004849 const VkBufferImageCopy *pRegions, const char *func_name) {
4850 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4851 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4852
4853 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004854 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004855
4856 // Command pool must support graphics, compute, or transfer operations
4857 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4858 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4859 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4860 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 -06004861 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004862 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004863 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004864 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004865 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004866 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004867 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004868 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004869 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004870 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4871 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4872 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4873 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4874 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004875 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004876 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4877 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4878 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4879 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4880 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004881 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4882 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004883 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4884 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004885 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004886 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004887 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004888 const std::string dst_invalid_layout_vuid =
4889 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4890 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4891 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004892 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004893 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4894 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004895 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004896 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4897 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004898 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004899 "vkCmdCopyBufferToImage()",
4900 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004901 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4902 "vkCmdCopyBufferToImage()", "imageSubresource",
4903 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4904 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4905 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4906 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004907 }
4908 return skip;
4909}
4910
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004911void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004912 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4913 VkImageLayout dst_image_layout) {
4914 // Make sure that all image slices are updated to correct layout
4915 for (uint32_t i = 0; i < region_count; ++i) {
4916 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4917 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004918 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004919 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004920}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004921
4922bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4923 const auto report_data = core_validation::GetReportData(device_data);
4924 bool skip = false;
4925 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4926
Dave Houlton1d960ff2018-01-19 12:17:05 -07004927 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004928 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4929 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4930 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004931 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 -06004932 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004933 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004934 }
4935
4936 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4937 if (!image_entry) {
4938 return skip;
4939 }
4940
Dave Houlton1d960ff2018-01-19 12:17:05 -07004941 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004942 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004943 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4944 "VUID-vkGetImageSubresourceLayout-image-00996",
4945 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004946 }
4947
Dave Houlton1d960ff2018-01-19 12:17:05 -07004948 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004949 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004950 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4951 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4952 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4953 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004954 }
4955
Dave Houlton1d960ff2018-01-19 12:17:05 -07004956 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004957 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004958 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4959 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4960 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4961 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004962 }
4963
Dave Houlton1d960ff2018-01-19 12:17:05 -07004964 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004965 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004966 if (FormatIsMultiplane(img_format)) {
4967 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Dave Houltond8ed0212018-05-16 17:18:24 -06004968 std::string vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004969 if (FormatPlaneCount(img_format) > 2u) {
4970 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004971 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004972 }
4973 if (sub_aspect != (sub_aspect & allowed_flags)) {
4974 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 -06004975 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004976 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004977 ") must be a single-plane specifier flag.",
4978 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004979 }
4980 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004981 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004982 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004983 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004984 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004985 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004986 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004987 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004988 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004989 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 -06004990 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004991 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004992 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004993 }
4994 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004995
4996 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
4997 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
4998 }
4999
Mike Weiblen672b58b2017-02-21 14:32:53 -07005000 return skip;
5001}