blob: e63a89f2aa1e7b78b2a2f79a8c125b34a4f43f3c [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>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070020 */
21
22// Allow use of STL min and max functions in Windows
23#define NOMINMAX
24
Mark Lobodzinski90224de2017-01-26 15:23:11 -070025#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020026#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027
28#include "vk_enum_string_helper.h"
29#include "vk_layer_data.h"
30#include "vk_layer_utils.h"
31#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060032#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070034#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070035
Tobin Ehlis58c884f2017-02-08 12:15:27 -070036void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070037 auto it = pCB->imageLayoutMap.find(imgpair);
38 if (it != pCB->imageLayoutMap.end()) {
39 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070040 } else {
41 assert(imgpair.hasSubresource);
42 IMAGE_CMD_BUF_LAYOUT_NODE node;
43 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
44 node.initialLayout = layout;
45 }
46 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
47 }
48}
49template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070050void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070051 ImageSubresourcePair imgpair = {image, true, range};
52 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
53 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
54 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
55 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -070056 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
57 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
58 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
59 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
60 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070061}
62
63template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070064void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070065 VkImageAspectFlags aspectMask) {
66 if (imgpair.subresource.aspectMask & aspectMask) {
67 imgpair.subresource.aspectMask = aspectMask;
68 SetLayout(device_data, pObject, imgpair, layout);
69 }
70}
71
Tony Barbourdf013b92017-01-25 12:53:48 -070072// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070073void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
74 VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070075 auto it = imageLayoutMap.find(imgpair);
76 if (it != imageLayoutMap.end()) {
77 it->second.layout = layout; // Update
78 } else {
79 imageLayoutMap[imgpair].layout = layout; // Insert
80 }
Tony Barbourdf013b92017-01-25 12:53:48 -070081}
82
Tobin Ehlisc8266452017-04-07 12:20:30 -060083bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070084 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
85 const debug_report_data *report_data = core_validation::GetReportData(device_data);
86
87 if (!(imgpair.subresource.aspectMask & aspectMask)) {
88 return false;
89 }
90 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
91 imgpair.subresource.aspectMask = aspectMask;
92 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
93 if (imgsubIt == pCB->imageLayoutMap.end()) {
94 return false;
95 }
96 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +020097 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 -060098 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070099 "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 +0200100 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700101 string_VkImageLayout(imgsubIt->second.layout));
102 }
103 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200104 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 -0600105 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700106 "Cannot query for VkImage 0x%" PRIx64
107 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200108 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700109 string_VkImageLayout(imgsubIt->second.initialLayout));
110 }
111 node = imgsubIt->second;
112 return true;
113}
114
Tobin Ehlisc8266452017-04-07 12:20:30 -0600115bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700116 const VkImageAspectFlags aspectMask) {
117 if (!(imgpair.subresource.aspectMask & aspectMask)) {
118 return false;
119 }
120 const debug_report_data *report_data = core_validation::GetReportData(device_data);
121 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
122 imgpair.subresource.aspectMask = aspectMask;
123 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
124 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
125 return false;
126 }
127 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200128 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 -0600129 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700130 "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 +0200131 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700132 string_VkImageLayout(imgsubIt->second.layout));
133 }
134 layout = imgsubIt->second.layout;
135 return true;
136}
137
138// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600139bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700140 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
141 ImageSubresourcePair imgpair = {image, true, range};
142 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
143 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
144 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
145 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
146 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700147 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
148 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
149 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
150 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
151 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700152 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
153 imgpair = {image, false, VkImageSubresource()};
154 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
155 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
156 // TODO: This is ostensibly a find function but it changes state here
157 node = imgsubIt->second;
158 }
159 return true;
160}
161
162// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700163bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700164 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
165 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
166 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
167 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
168 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700169 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
170 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
171 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
172 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
173 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700174 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
175 imgpair = {imgpair.image, false, VkImageSubresource()};
176 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
177 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
178 layout = imgsubIt->second.layout;
179 }
180 return true;
181}
182
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700183bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700184 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
185 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700186 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700187 if (!image_state) return false;
188 bool ignoreGlobal = false;
189 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
190 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
191 ignoreGlobal = true;
192 }
193 for (auto imgsubpair : sub_data->second) {
194 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
195 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
196 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
197 layouts.push_back(img_data->second.layout);
198 }
199 }
200 return true;
201}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700202bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
203 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700204 if (!(imgpair.subresource.aspectMask & aspectMask)) {
205 return false;
206 }
207 imgpair.subresource.aspectMask = aspectMask;
208 auto imgsubIt = imageLayoutMap.find(imgpair);
209 if (imgsubIt == imageLayoutMap.end()) {
210 return false;
211 }
212 layout = imgsubIt->second.layout;
213 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700214}
Tony Barbourdf013b92017-01-25 12:53:48 -0700215
216// find layout in supplied map
Dave Houltonb3f4b282018-02-22 16:25:16 -0700217bool FindLayout(layer_data *device_data, const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
218 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700219 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
220 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
221 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
222 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
223 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700224 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
225 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
226 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
227 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
228 }
229 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700230 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
231 imgpair = {imgpair.image, false, VkImageSubresource()};
232 auto imgsubIt = imageLayoutMap.find(imgpair);
233 if (imgsubIt == imageLayoutMap.end()) return false;
234 layout = imgsubIt->second.layout;
235 }
236 return true;
237}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700238
239// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700240void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700241 VkImage &image = imgpair.image;
Dave Houltonb3f4b282018-02-22 16:25:16 -0700242 auto &lmap = (*core_validation::GetImageLayoutMap(device_data));
243 auto data = lmap.find(imgpair);
244 if (data != lmap.end()) {
245 data->second.layout = layout; // Update
246 } else {
247 lmap[imgpair].layout = layout; // Insert
248 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700249 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
250 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
251 if (subresource == image_subresources.end()) {
252 image_subresources.push_back(imgpair);
253 }
254}
255
256// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700257void 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 -0700258 auto it = pCB->imageLayoutMap.find(imgpair);
259 if (it != pCB->imageLayoutMap.end()) {
260 it->second = node; // Update
261 } else {
262 pCB->imageLayoutMap[imgpair] = node; // Insert
263 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700264}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600265// Set image layout for given VkImageSubresourceRange struct
266void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
267 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
268 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700269 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600270 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
271 uint32_t level = image_subresource_range.baseMipLevel + level_index;
272 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
273 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
274 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700275 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
276 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600277 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600278 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700279 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
280 }
281 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600282 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700283 }
284 }
285}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600286// Set image layout for given VkImageSubresourceLayers struct
287void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
288 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
289 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
290 VkImageSubresourceRange image_subresource_range;
291 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
292 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
293 image_subresource_range.layerCount = image_subresource_layers.layerCount;
294 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
295 image_subresource_range.levelCount = 1;
296 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
297}
Dave Houltonddd65c52018-05-08 14:58:01 -0600298
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600299// Set image layout for all slices of an image view
John Zulauf4ccf5c02018-09-21 11:46:18 -0600300void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_VIEW_STATE *view_state,
301 const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600302 assert(view_state);
303
Dave Houltonddd65c52018-05-08 14:58:01 -0600304 IMAGE_STATE *image_state = GetImageState(device_data, view_state->create_info.image);
305 VkImageSubresourceRange sub_range = view_state->create_info.subresourceRange;
306
307 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
308 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
309 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state->create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
310 sub_range.baseArrayLayer = 0;
311 sub_range.layerCount = image_state->createInfo.extent.depth;
312 }
313
314 SetImageLayout(device_data, cb_node, image_state, sub_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600315}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700316
John Zulauf4ccf5c02018-09-21 11:46:18 -0600317void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
318 auto view_state = GetImageViewState(device_data, imageView);
319 SetImageViewLayout(device_data, cb_node, view_state, layout);
320}
321
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700322bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700323 const VkRenderPassBeginInfo *pRenderPassBegin,
324 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600325 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700326 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700327 auto const &framebufferInfo = framebuffer_state->createInfo;
328 const auto report_data = core_validation::GetReportData(device_data);
329 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600330 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 -0600331 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700332 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700333 }
334 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
335 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700336 auto view_state = GetImageViewState(device_data, image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600337
338 if (!view_state) {
339 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
340 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
341 "vkCmdBeginRenderPass() :framebuffer 0x%" PRIx64 " pAttachments[%" PRIu32 "] = 0x%" PRIx64
342 " is not a valid VkImageView handle",
343 HandleToUint64(framebuffer_state->framebuffer), i, HandleToUint64(image_view));
344 continue;
345 }
346
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700347 const VkImage &image = view_state->create_info.image;
348 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700349 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700350 // TODO: Do not iterate over every possibility - consolidate where possible
351 for (uint32_t j = 0; j < subRange.levelCount; j++) {
352 uint32_t level = subRange.baseMipLevel + j;
353 for (uint32_t k = 0; k < subRange.layerCount; k++) {
354 uint32_t layer = subRange.baseArrayLayer + k;
355 VkImageSubresource sub = {subRange.aspectMask, level, layer};
356 IMAGE_CMD_BUF_LAYOUT_NODE node;
357 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700358 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700359 continue;
360 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700361 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600362 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 -0600363 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700364 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
365 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
366 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600367 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700368 }
369 }
370 }
371 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600372 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700373}
374
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700375void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700376 VkAttachmentReference ref) {
377 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf8e308292018-09-21 11:34:37 -0600378 auto image_view = GetAttachmentImageViewState(device_data, pFramebuffer, ref.attachment);
379 if (image_view) {
380 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
381 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700382 }
383}
384
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700385void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700386 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700387 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700388
389 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700390 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700391 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
392 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
393 }
394 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
395 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
396 }
397 if (subpass.pDepthStencilAttachment) {
398 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
399 }
400 }
401}
402
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600403bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700404 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700405 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
406 return false;
407 }
408 VkImageSubresource sub = {aspect, level, layer};
409 IMAGE_CMD_BUF_LAYOUT_NODE node;
410 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700411 return false;
412 }
413 bool skip = false;
414 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
415 // TODO: Set memory invalid which is in mem_tracker currently
416 } else if (node.layout != mem_barrier->oldLayout) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600417 skip = log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
418 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
419 "VUID-VkImageMemoryBarrier-oldLayout-01197",
420 "For image 0x%" PRIx64
421 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
422 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
423 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700424 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700425 return skip;
426}
427
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700428// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
429// 1. Transition into initialLayout state
430// 2. Transition from initialLayout to layout used in subpass 0
431void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
432 FRAMEBUFFER_STATE *framebuffer_state) {
433 // First transition into initialLayout
434 auto const rpci = render_pass_state->createInfo.ptr();
435 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -0600436 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
437 if (view_state) {
438 SetImageViewLayout(device_data, cb_state, view_state, rpci->pAttachments[i].initialLayout);
439 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700440 }
441 // Now transition for first subpass (index 0)
442 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
443}
444
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700445void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
446 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
447 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
448 return;
449 }
450 VkImageSubresource sub = {aspect, level, layer};
451 IMAGE_CMD_BUF_LAYOUT_NODE node;
452 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700453 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700454 SetLayout(device_data, pCB, mem_barrier->image, sub,
455 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
456 return;
457 }
458 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
459 // TODO: Set memory invalid
460 }
461 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
462}
463
Dave Houlton10b39482017-03-16 13:18:15 -0600464bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600465 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600466 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600467 }
468 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600469 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600470 }
471 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600472 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600473 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700474 if (0 !=
475 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
476 if (FormatPlaneCount(format) == 1) return false;
477 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600478 return true;
479}
480
Mike Weiblen62d08a32017-03-07 22:18:27 -0700481// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
482bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
483 VkImageUsageFlags usage_flags, const char *func_name) {
484 const auto report_data = core_validation::GetReportData(device_data);
485 bool skip = false;
486 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Dave Houlton8e9f6542018-05-18 12:18:22 -0600487 std::string msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700488
489 switch (layout) {
490 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
491 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600492 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700493 }
494 break;
495 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
496 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600497 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700498 }
499 break;
500 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
501 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600502 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700503 }
504 break;
505 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
506 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600507 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700508 }
509 break;
510 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
511 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600512 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700513 }
514 break;
515 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
516 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600517 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700518 }
519 break;
Jeff Bolz9af91c52018-09-01 21:53:57 -0500520 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV :
521 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
522 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
523 }
524 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700525 default:
526 // Other VkImageLayout values do not have VUs defined in this context.
527 break;
528 }
529
Dave Houlton8e9f6542018-05-18 12:18:22 -0600530 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600531 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 -0600532 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600533 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
534 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
535 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700536 }
537 return skip;
538}
539
John Zulauf463c51e2018-05-31 13:29:20 -0600540// Scoreboard for checking for duplicate and inconsistent barriers to images
541struct ImageBarrierScoreboardEntry {
542 uint32_t index;
543 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
544 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
545 const VkImageMemoryBarrier *barrier;
546};
547using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
548using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
549
Mike Weiblen62d08a32017-03-07 22:18:27 -0700550// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600551bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700552 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700553 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700554
John Zulauf463c51e2018-05-31 13:29:20 -0600555 // Scoreboard for duplicate layout transition barriers within the list
556 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
557 ImageBarrierScoreboardImageMap layout_transitions;
558
Mike Weiblen62d08a32017-03-07 22:18:27 -0700559 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
560 auto img_barrier = &pImageMemoryBarriers[i];
561 if (!img_barrier) continue;
562
John Zulauf463c51e2018-05-31 13:29:20 -0600563 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
564 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
565 // at a per sub-resource level
566 if (img_barrier->oldLayout != img_barrier->newLayout) {
567 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
568 auto image_it = layout_transitions.find(img_barrier->image);
569 if (image_it != layout_transitions.end()) {
570 auto &subres_map = image_it->second;
571 auto subres_it = subres_map.find(img_barrier->subresourceRange);
572 if (subres_it != subres_map.end()) {
573 auto &entry = subres_it->second;
574 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
575 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
576 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
577 skip = log_msg(
578 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
579 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_state->commandBuffer),
580 "VUID-VkImageMemoryBarrier-oldLayout-01197",
581 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image 0x%" PRIx64
582 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
583 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
584 func_name, i, entry.index, HandleToUint64(img_barrier->image), range.aspectMask, range.baseMipLevel,
585 range.levelCount, range.baseArrayLayer, range.layerCount, string_VkImageLayout(img_barrier->oldLayout),
586 string_VkImageLayout(entry.barrier->newLayout));
587 }
588 entry = new_entry;
589 } else {
590 subres_map[img_barrier->subresourceRange] = new_entry;
591 }
592 } else {
593 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
594 }
595 }
596
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600597 auto image_state = GetImageState(device_data, img_barrier->image);
598 if (image_state) {
599 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
600 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
601 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
602
603 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
604 if (image_state->layout_locked) {
605 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600606 skip |= log_msg(
607 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Young9d1ac312018-05-21 16:28:27 -0600608 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100609 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600610 " 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 +0100611 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600612 string_VkImageLayout(img_barrier->newLayout));
613 }
614 }
615
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600616 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600617 // For a Depth/Stencil image both aspects MUST be set
618 if (FormatIsDepthAndStencil(image_create_info->format)) {
619 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
620 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
621 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600622 skip |=
623 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -0600624 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image),
625 "VUID-VkImageMemoryBarrier-image-01207",
Mark Lobodzinski88529492018-04-01 10:38:15 -0600626 "%s: Image barrier 0x%p references image 0x%" PRIx64
627 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
628 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
629 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600630 }
631 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600632 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
633 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700634
Mike Weiblen62d08a32017-03-07 22:18:27 -0700635 for (uint32_t j = 0; j < level_count; j++) {
636 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
637 for (uint32_t k = 0; k < layer_count; k++) {
638 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600639 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
640 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
641 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
642 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700643 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
644 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
645 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
646 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
647 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
648 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
649 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
650 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700651 }
652 }
653 }
654 return skip;
655}
656
Chris Forbes4de4b132017-08-21 11:27:08 -0700657static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600658 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700659
660 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600661 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700662}
663
John Zulauf6b4aae82018-05-09 13:03:36 -0600664template <typename Barrier>
665bool ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
666 uint32_t barrier_count, const Barrier *barriers) {
667 using BarrierRecord = QFOTransferBarrier<Barrier>;
668 bool skip = false;
669 const auto report_data = core_validation::GetReportData(device_data);
670 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
671 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
672 const char *barrier_name = BarrierRecord::BarrierName();
673 const char *handle_name = BarrierRecord::HandleName();
674 const char *transfer_type = nullptr;
675 for (uint32_t b = 0; b < barrier_count; b++) {
676 if (!IsTransferOp(&barriers[b])) continue;
677 const BarrierRecord *barrier_record = nullptr;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600678 if (IsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600679 const auto found = barrier_sets.release.find(barriers[b]);
680 if (found != barrier_sets.release.cend()) {
681 barrier_record = &(*found);
682 transfer_type = "releasing";
683 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600684 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
685 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600686 const auto found = barrier_sets.acquire.find(barriers[b]);
687 if (found != barrier_sets.acquire.cend()) {
688 barrier_record = &(*found);
689 transfer_type = "acquiring";
690 }
691 }
692 if (barrier_record != nullptr) {
693 skip |=
694 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
695 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
696 "%s: %s at index %" PRIu32 " %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
697 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
698 func_name, barrier_name, b, transfer_type, handle_name, HandleToUint64(barrier_record->handle),
699 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
700 }
701 }
702 return skip;
703}
704
705template <typename Barrier>
706void RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
707 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
708 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
709 for (uint32_t b = 0; b < barrier_count; b++) {
710 if (!IsTransferOp(&barriers[b])) continue;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600711 if (IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600712 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600713 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
714 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600715 barrier_sets.acquire.emplace(barriers[b]);
716 }
717 }
718}
719
720bool ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
721 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
722 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
723 bool skip = false;
724 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
725 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
726 return skip;
727}
728
729void RecordBarriersQFOTransfers(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
730 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
731 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
732 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
733 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
734}
735
736template <typename BarrierRecord, typename Scoreboard>
737static bool ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
738 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
739 // Record to the scoreboard or report that we have a duplication
740 bool skip = false;
741 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
742 if (!inserted.second && inserted.first->second != cb_state) {
743 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
744 skip = log_msg(
745 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
746 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
747 "%s: %s %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
748 " duplicates existing barrier submitted in this batch from command buffer 0x%" PRIx64 ".",
749 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(), HandleToUint64(barrier.handle),
750 barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex, HandleToUint64(inserted.first->second));
751 }
752 return skip;
753}
754
755template <typename Barrier>
756static bool ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
757 QFOTransferCBScoreboards<Barrier> *scoreboards) {
758 using BarrierRecord = QFOTransferBarrier<Barrier>;
759 using TypeTag = typename BarrierRecord::Tag;
760 bool skip = false;
761 const auto report_data = core_validation::GetReportData(device_data);
762 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
763 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
764 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
765 const char *barrier_name = BarrierRecord::BarrierName();
766 const char *handle_name = BarrierRecord::HandleName();
767 // No release should have an extant duplicate (WARNING)
768 for (const auto &release : cb_barriers.release) {
769 // Check the global pending release barriers
770 const auto set_it = global_release_barriers.find(release.handle);
771 if (set_it != global_release_barriers.cend()) {
772 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
773 const auto found = set_for_handle.find(release);
774 if (found != set_for_handle.cend()) {
775 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
776 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
777 "%s: %s releasing queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
778 " to dstQueueFamilyIndex %" PRIu32
779 " duplicates existing barrier queued for execution, without intervening acquire operation.",
780 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(found->handle),
781 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
782 }
783 }
784 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
785 }
786 // Each acquire must have a matching release (ERROR)
787 for (const auto &acquire : cb_barriers.acquire) {
788 const auto set_it = global_release_barriers.find(acquire.handle);
789 bool matching_release_found = false;
790 if (set_it != global_release_barriers.cend()) {
791 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
792 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
793 }
794 if (!matching_release_found) {
795 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
796 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
797 "%s: in submitted command buffer %s aquiring ownership of %s (0x%" PRIx64
798 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
799 " has no matching release barrier queued for execution.",
800 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(acquire.handle),
801 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
802 }
803 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
804 }
805 return skip;
806}
807
808bool ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
809 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
810 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
811 bool skip = false;
812 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
813 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
814 return skip;
815}
816
817template <typename Barrier>
818static void RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
819 using BarrierRecord = QFOTransferBarrier<Barrier>;
820 using TypeTag = typename BarrierRecord::Tag;
821 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
822 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
823 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
824
825 // Add release barriers from this submit to the global map
826 for (const auto &release : cb_barriers.release) {
827 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
828 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
829 global_release_barriers[release.handle].insert(release);
830 }
831
832 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
833 for (const auto &acquire : cb_barriers.acquire) {
834 // NOTE: We're not using [] because we don't want to create entries for missing releases
835 auto set_it = global_release_barriers.find(acquire.handle);
836 if (set_it != global_release_barriers.end()) {
837 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
838 set_for_handle.erase(acquire);
839 if (set_for_handle.size() == 0) { // Clean up empty sets
840 global_release_barriers.erase(set_it);
841 }
842 }
843 }
844}
845
846void RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
847 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
848 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
849}
850
851// Remove the pending QFO release records from the global set
852// Note that the type of the handle argument constrained to match Barrier type
853// The defaulted BarrierRecord argument allows use to declare the type once, but is not intended to be specified by the caller
854template <typename Barrier, typename BarrierRecord = QFOTransferBarrier<Barrier>>
855static void EraseQFOReleaseBarriers(layer_data *device_data, const typename BarrierRecord::HandleType &handle) {
856 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
857 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, typename BarrierRecord::Tag());
858 global_release_barriers.erase(handle);
859}
860
861// Avoid making the template globally visible by exporting the one instance of it we need.
862void EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
863 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
864}
865
Chris Forbes399a6782017-08-18 15:00:48 -0700866void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700867 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700868 for (uint32_t i = 0; i < memBarrierCount; ++i) {
869 auto mem_barrier = &pImgMemBarriers[i];
870 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700871
Chris Forbes4de4b132017-08-21 11:27:08 -0700872 // For ownership transfers, the barrier is specified twice; as a release
873 // operation on the yielding queue family, and as an acquire operation
874 // on the acquiring queue family. This barrier may also include a layout
875 // transition, which occurs 'between' the two operations. For validation
876 // purposes it doesn't seem important which side performs the layout
877 // transition, but it must not be performed twice. We'll arbitrarily
878 // choose to perform it as part of the acquire operation.
879 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
880 continue;
881 }
882
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600883 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
884 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
885 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
886
Dave Houltonb3f4b282018-02-22 16:25:16 -0700887 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
888 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
889 // for all (potential) layer sub_resources.
890 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
891 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
892 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
893 }
894
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600895 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700896 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600897 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700898 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Chris Forbes399a6782017-08-18 15:00:48 -0700899 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
900 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
901 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
902 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700903 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Chris Forbes399a6782017-08-18 15:00:48 -0700904 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
905 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
906 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700907 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700908 }
909 }
910 }
911}
912
Tobin Ehlisc8266452017-04-07 12:20:30 -0600913bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600914 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Cort Stratton7df30962018-05-17 19:45:57 -0700915 const char *caller, const std::string &layout_invalid_msg_code, const std::string &layout_mismatch_msg_code,
916 bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700917 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600918 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600919 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700920
921 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
922 uint32_t layer = i + subLayers.baseArrayLayer;
923 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
924 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600925 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
926 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600927 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -0700928 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
929 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
930 "%s: Cannot use image 0x%" PRIx64
931 " (layer=%u mip=%u) with specific layout %s that doesn't match the actual current layout %s.",
932 caller, HandleToUint64(image), layer, subLayers.mipLevel, string_VkImageLayout(explicit_layout),
933 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600934 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700935 }
936 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600937 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
938 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
939 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700940 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
941 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600942 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600943 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -0600944 kVUID_Core_DrawState_InvalidImageLayout,
Petr Kraus13c98a62017-12-09 00:22:39 +0100945 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
946 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700947 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600948 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600949 if (image_state->shared_presentable) {
950 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -0700951 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
952 layout_invalid_msg_code,
953 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
954 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600955 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600956 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700957 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600958 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600959 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 -0700960 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600961 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
962 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700963 }
964 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600965 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700966}
967
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700968void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
969 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700970 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700971 if (!renderPass) return;
972
973 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
974 if (framebuffer_state) {
975 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -0600976 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
977 if (view_state) {
978 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
979 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700980 }
981 }
982}
Dave Houltone19e20d2018-02-02 16:32:41 -0700983
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700984bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700985 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600986 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700987 const debug_report_data *report_data = core_validation::GetReportData(device_data);
988
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600989 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600990 skip |=
991 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
992 "VUID-VkImageCreateInfo-format-00943", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600993
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600994 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600995 }
996
Dave Houlton130c0212018-01-29 13:39:56 -0700997 const char *format_string = string_VkFormat(pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700998
999 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
1000 std::stringstream ss;
1001 ss << "vkCreateImage: Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001002 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 -06001003 "VUID-VkImageCreateInfo-flags-00949", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001004 }
1005
1006 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
1007 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
1008 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
1009 if (VK_SUCCESS != err) {
1010 std::stringstream ss;
1011 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
1012 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001013 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 -06001014 "VUID-VkImageCreateInfo-format-00940", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001015 return skip;
1016 }
1017
1018 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
1019 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
1020 std::stringstream ss;
1021 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001022 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 -06001023 "VUID-VkImageCreateInfo-imageType-00951", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001024 }
1025
1026 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
1027 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
1028 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
1029 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001030 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -07001031 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001032 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 -06001033 "VUID-VkImageCreateInfo-imageType-00952", "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06001034 }
Dave Houlton130c0212018-01-29 13:39:56 -07001035 } else {
1036 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
1037 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001038 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -07001039 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
1040 "format "
1041 << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001042 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 -06001043 "VUID-VkImageCreateInfo-imageType-00953", "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06001044 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001045 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001046 }
1047
Dave Houlton130c0212018-01-29 13:39:56 -07001048 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
1049 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
1050 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
1051 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
1052 std::stringstream ss;
1053 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001054 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 -06001055 "VUID-VkImageCreateInfo-imageType-00955", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001056 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001057 }
1058
Dave Houlton130c0212018-01-29 13:39:56 -07001059 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1060 std::stringstream ss;
1061 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001062 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 -06001063 "VUID-VkImageCreateInfo-extent-00959", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001064 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001065
Dave Houlton130c0212018-01-29 13:39:56 -07001066 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1067 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1068 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
1069 std::stringstream ss;
1070 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
1071 "maxFramebufferWidth";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001072 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 -06001073 "VUID-VkImageCreateInfo-usage-00964", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001074 }
1075
1076 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
1077 std::stringstream ss;
1078 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
1079 "maxFramebufferHeight";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001080 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 -06001081 "VUID-VkImageCreateInfo-usage-00965", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001082 }
1083
1084 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1085 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1086 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
1087
1088 // Round up to imageGranularity boundary
1089 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
1090 uint64_t ig_mask = imageGranularity - 1;
1091 total_size = (total_size + ig_mask) & ~ig_mask;
1092
1093 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001094 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06001095 kVUID_Core_Image_InvalidFormatLimitsViolation,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001096 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1097 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -07001098 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001099 }
1100
Dave Houlton130c0212018-01-29 13:39:56 -07001101 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001102 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1103 "VUID-VkImageCreateInfo-arrayLayers-00960",
1104 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d.", pCreateInfo->arrayLayers,
1105 format_limits.maxArrayLayers);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001106 }
1107
Dave Houlton130c0212018-01-29 13:39:56 -07001108 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001109 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06001110 "VUID-VkImageCreateInfo-samples-00967", "CreateImage samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001111 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001112 }
1113
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06001114 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) &&
1115 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001116 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 -06001117 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001118 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1119 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001120 }
1121
Lenny Komowb79f04a2017-09-18 17:07:00 -06001122 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1123 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1124 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1125 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1126 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001127 skip |=
1128 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1129 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1130 "format must be block, ETC or ASTC compressed, but is %s",
1131 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001132 }
1133 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1134 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001135 skip |=
1136 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1137 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1138 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001139 }
1140 }
1141 }
1142
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001143 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001144}
1145
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001146void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001147 IMAGE_LAYOUT_NODE image_state;
1148 image_state.layout = pCreateInfo->initialLayout;
1149 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001150 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(new IMAGE_STATE(*pImage, pCreateInfo))));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001151 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001152 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1153 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001154}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001155
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001156bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001157 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001158 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +02001159 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001160 if (disabled->destroy_image) return false;
1161 bool skip = false;
1162 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06001163 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001164 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001165 }
1166 return skip;
1167}
1168
John Zulauffca05c12018-04-26 16:30:39 -06001169void PreCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001170 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001171 // Clean up memory mapping, bindings and range references for image
1172 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001173 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001174 if (mem_info) {
1175 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1176 }
1177 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001178 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001179 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001180 // Remove image from imageMap
1181 core_validation::GetImageMap(device_data)->erase(image);
1182 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1183 core_validation::GetImageSubresourceMap(device_data);
1184
1185 const auto &sub_entry = imageSubresourceMap->find(image);
1186 if (sub_entry != imageSubresourceMap->end()) {
1187 for (const auto &pair : sub_entry->second) {
1188 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1189 }
1190 imageSubresourceMap->erase(sub_entry);
1191 }
1192}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001193
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001194bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001195 bool skip = false;
1196 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1197
1198 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1199 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1200 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 -06001201 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001202 }
1203
Dave Houlton1d2022c2017-03-29 11:43:58 -06001204 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001205 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1206 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 -06001207 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001208 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001209 char const str[] = "vkCmdClearColorImage called with compressed image.";
1210 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 -06001211 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001212 }
1213
1214 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1215 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1216 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 -06001217 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001218 }
1219 return skip;
1220}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001221
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001222uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1223 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1224 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001225 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001226 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001227 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001228 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001229}
1230
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001231uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1232 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1233 uint32_t array_layer_count = range->layerCount;
1234 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1235 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001236 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001237 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001238}
1239
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001240bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001241 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1242 bool skip = false;
1243 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1244
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001245 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1246 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001247
1248 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1249 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001250 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1251 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001252 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 -06001253 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001254 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1255 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001256 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001257 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001258 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001259 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 -06001260 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001261 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1262 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001263
1264 } else {
1265 if (image_state->shared_presentable) {
1266 skip |= log_msg(
1267 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001268 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001269 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1270 string_VkImageLayout(dest_image_layout));
1271 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001272 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001273 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001274 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001275 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001276 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001277 } else {
1278 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1279 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001280 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 -06001281 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001282 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1283 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001284 }
1285 }
1286
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001287 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1288 uint32_t level = level_index + range.baseMipLevel;
1289 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1290 uint32_t layer = layer_index + range.baseArrayLayer;
1291 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001292 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001293 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001294 if (node.layout != dest_image_layout) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001295 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001296 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001297 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001298 } else {
1299 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1300 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001301 skip |=
1302 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1303 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1304 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001305 }
1306 }
1307 }
1308 }
1309
1310 return skip;
1311}
1312
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001313void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1314 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001315 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1316 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1317 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001318
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001319 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1320 uint32_t level = level_index + range.baseMipLevel;
1321 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1322 uint32_t layer = layer_index + range.baseArrayLayer;
1323 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001324 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001325 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1326 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 -07001327 }
1328 }
1329 }
1330}
1331
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001332bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001333 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1334 bool skip = false;
1335 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001336 auto cb_node = GetCBNode(dev_data, commandBuffer);
1337 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001338 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001339 skip |=
1340 ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001341 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001342 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001343 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001344 if (GetApiVersion(dev_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001345 skip |=
1346 ValidateImageFormatFeatureFlags(dev_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001347 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001348 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001349 skip |= InsideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001350 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001351 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001352 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001353 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001354 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001355 }
1356 }
1357 return skip;
1358}
1359
1360// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001361void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001362 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001363 auto cb_node = GetCBNode(dev_data, commandBuffer);
1364 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001365 if (cb_node && image_state) {
1366 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001367 for (uint32_t i = 0; i < rangeCount; ++i) {
1368 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1369 }
1370 }
1371}
1372
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001373bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1374 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001375 const VkImageSubresourceRange *pRanges) {
1376 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001377 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1378
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001379 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001380 auto cb_node = GetCBNode(device_data, commandBuffer);
1381 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001382 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001383 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1384 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001385 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001386 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001387 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001388 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1389 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001390 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1391 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001392 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001393 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001394 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001395 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001396 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001397 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001398 skip |=
1399 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001400 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001401 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1402 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001403 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001404 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1405 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001406 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 -06001407 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001408 }
1409 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001410 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001411 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001412 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 -06001413 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001414 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001415 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1416 char const str[] =
1417 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1418 "set.";
1419 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 -06001420 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001421 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001422 }
1423 return skip;
1424}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001425
1426// Returns true if [x, xoffset] and [y, yoffset] overlap
1427static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1428 bool result = false;
1429 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1430 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1431
1432 if (intersection_max > intersection_min) {
1433 result = true;
1434 }
1435 return result;
1436}
1437
Dave Houltonc991cc92018-03-06 11:08:51 -07001438// Returns true if source area of first copy region intersects dest area of second region
1439// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1440static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001441 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001442
Dave Houltonc991cc92018-03-06 11:08:51 -07001443 // Separate planes within a multiplane image cannot intersect
1444 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001445 return result;
1446 }
1447
Dave Houltonc991cc92018-03-06 11:08:51 -07001448 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1449 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1450 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001451 result = true;
1452 switch (type) {
1453 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001454 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001455 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001456 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001457 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001458 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001459 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001460 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001461 break;
1462 default:
1463 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1464 assert(false);
1465 }
1466 }
1467 return result;
1468}
1469
Dave Houltonfc1a4052017-04-27 14:32:45 -06001470// Returns non-zero if offset and extent exceed image extents
1471static const uint32_t x_bit = 1;
1472static const uint32_t y_bit = 2;
1473static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001474static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001475 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001476 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001477 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1478 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001479 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001480 }
1481 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1482 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001483 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001484 }
1485 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1486 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001487 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001488 }
1489 return result;
1490}
1491
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001492// Test if two VkExtent3D structs are equivalent
1493static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1494 bool result = true;
1495 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1496 (extent->depth != other_extent->depth)) {
1497 result = false;
1498 }
1499 return result;
1500}
1501
Dave Houltonee281a52017-12-08 13:51:02 -07001502// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1503// Destination image texel extents must be adjusted by block size for the dest validation checks
1504VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1505 VkExtent3D adjusted_extent = extent;
1506 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1507 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1508 adjusted_extent.width /= block_size.width;
1509 adjusted_extent.height /= block_size.height;
1510 adjusted_extent.depth /= block_size.depth;
1511 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1512 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1513 adjusted_extent.width *= block_size.width;
1514 adjusted_extent.height *= block_size.height;
1515 adjusted_extent.depth *= block_size.depth;
1516 }
1517 return adjusted_extent;
1518}
1519
Dave Houlton6f9059e2017-05-02 17:15:13 -06001520// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001521static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1522 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001523
1524 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001525 if (mip >= img->createInfo.mipLevels) {
1526 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001527 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001528
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001529 // 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 -06001530 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001531
1532 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1533 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
1534 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1)>> mip)));
1535 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1536 } else {
1537 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1538 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1539 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1540 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001541
Dave Houlton6f9059e2017-05-02 17:15:13 -06001542 // Image arrays have an effective z extent that isn't diminished by mip level
1543 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001544 extent.depth = img->createInfo.arrayLayers;
1545 }
1546
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001547 return extent;
1548}
1549
1550// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001551static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001552 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1553}
1554
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001555// Test if the extent argument has any dimensions set to 0.
1556static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1557 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1558}
1559
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001560// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1561static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1562 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1563 VkExtent3D granularity = {0, 0, 0};
1564 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1565 if (pPool) {
1566 granularity =
1567 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001568 if (FormatIsCompressed(img->createInfo.format)) {
1569 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001570 granularity.width *= block_size.width;
1571 granularity.height *= block_size.height;
1572 }
1573 }
1574 return granularity;
1575}
1576
1577// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1578static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1579 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001580 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1581 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001582 valid = false;
1583 }
1584 return valid;
1585}
1586
1587// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1588static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001589 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001590 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001591 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1592 bool skip = false;
1593 VkExtent3D offset_extent = {};
1594 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1595 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1596 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001597 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001598 // 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 -07001599 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001600 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 -04001601 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001602 "%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 "
1603 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001604 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001605 }
1606 } else {
1607 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1608 // integer multiples of the image transfer granularity.
1609 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001610 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 -04001611 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001612 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1613 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001614 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1615 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001616 }
1617 }
1618 return skip;
1619}
1620
1621// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1622static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1623 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001624 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001625 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001626 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1627 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001628 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001629 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1630 // subresource extent.
1631 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001632 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 -04001633 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001634 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1635 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1636 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1637 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001638 }
1639 } else {
1640 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1641 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1642 // subresource extent dimensions.
1643 VkExtent3D offset_extent_sum = {};
1644 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1645 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1646 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001647 bool x_ok = true;
1648 bool y_ok = true;
1649 bool z_ok = true;
1650 switch (image_type) {
1651 case VK_IMAGE_TYPE_3D:
1652 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1653 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001654 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001655 case VK_IMAGE_TYPE_2D:
1656 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1657 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001658 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001659 case VK_IMAGE_TYPE_1D:
1660 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1661 (subresource_extent->width == offset_extent_sum.width));
1662 break;
1663 default:
1664 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1665 assert(false);
1666 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001667 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001668 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 -04001669 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001670 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1671 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1672 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1673 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1674 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1675 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001676 }
1677 }
1678 return skip;
1679}
1680
Cort Strattonff1542a2018-05-27 10:49:28 -07001681bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
1682 const uint32_t i, const char *function, const char *member, const std::string &vuid) {
1683 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1684 bool skip = false;
1685 if (mip_level >= img->createInfo.mipLevels) {
1686 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1687 HandleToUint64(cb_node->commandBuffer), vuid,
1688 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
1689 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
1690 }
1691 return skip;
1692}
1693
1694bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
1695 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
1696 const char *member, const std::string &vuid) {
1697 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1698 bool skip = false;
1699 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
1700 (base_layer + layer_count) > img->createInfo.arrayLayers) {
1701 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1702 HandleToUint64(cb_node->commandBuffer), vuid,
1703 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
1704 "%u, but provided image %" PRIx64 " has %u array layers.",
1705 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
1706 }
1707 return skip;
1708}
1709
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001710// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001711bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1712 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Dave Houltone0969282018-05-23 15:54:31 -06001713 const uint32_t i, const char *function, const std::string &vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001714 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04001715 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1716 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
1717 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1718 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1719 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001720 return skip;
1721}
1722
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001723// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001724bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001725 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1726 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001727 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001728 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001729 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06001730 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
1731 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001732 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001733 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001734 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06001735 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001736
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001737 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001738 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06001739 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
1740 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07001741 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001742 const VkExtent3D dest_effective_extent =
1743 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001744 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001745 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06001746 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001747 return skip;
1748}
1749
Dave Houlton6f9059e2017-05-02 17:15:13 -06001750// Validate contents of a VkImageCopy struct
1751bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1752 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1753 bool skip = false;
1754
1755 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001756 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001757
1758 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001759 const VkExtent3D src_copy_extent = region.extent;
1760 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001761 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1762
Dave Houlton6f9059e2017-05-02 17:15:13 -06001763 bool slice_override = false;
1764 uint32_t depth_slices = 0;
1765
1766 // Special case for copying between a 1D/2D array and a 3D image
1767 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1768 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001769 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001770 slice_override = (depth_slices != 1);
1771 } 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 -07001772 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001773 slice_override = (depth_slices != 1);
1774 }
1775
1776 // Do all checks on source image
1777 //
1778 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001779 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1780 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 -06001781 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07001782 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001783 "be 0 and 1, respectively.",
1784 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001785 }
1786 }
1787
Dave Houlton533be9f2018-03-26 17:08:30 -06001788 // VUID-VkImageCopy-srcImage-01785
1789 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1790 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001791 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06001792 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001793 "these must be 0 and 1, respectively.",
1794 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001795 }
1796
Dave Houlton533be9f2018-03-26 17:08:30 -06001797 // VUID-VkImageCopy-srcImage-01787
1798 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1799 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 -06001800 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001801 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
1802 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06001803 }
1804
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001805 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001806 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001807 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001808 skip |=
1809 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001810 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001811 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001812 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1813 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001814 }
1815 }
1816 } else { // Pre maint 1
1817 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001818 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001819 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 -06001820 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01001821 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1822 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001823 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1824 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001825 }
1826 }
1827 }
1828
Dave Houltonc991cc92018-03-06 11:08:51 -07001829 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1830 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
1831 if (FormatIsCompressed(src_state->createInfo.format) ||
1832 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001833 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001834 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001835 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1836 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1837 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001838 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001839 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 -07001840 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001841 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001842 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001843 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001844 }
1845
Dave Houlton94a00372017-12-14 15:08:47 -07001846 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001847 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1848 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001849 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001850 skip |=
1851 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001852 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001853 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001854 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001855 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001856 }
1857
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001858 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001859 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1860 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001861 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001862 skip |=
1863 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001864 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001865 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001866 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001867 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001868 }
1869
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001870 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001871 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1872 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001873 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001874 skip |=
1875 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001876 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001877 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001878 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001879 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001880 }
1881 } // Compressed
1882
1883 // Do all checks on dest image
1884 //
1885 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001886 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001887 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 -06001888 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001889 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001890 "these must be 0 and 1, respectively.",
1891 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001892 }
1893 }
1894
Dave Houlton533be9f2018-03-26 17:08:30 -06001895 // VUID-VkImageCopy-dstImage-01786
1896 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
1897 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 -06001898 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06001899 "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 -06001900 "and 1, respectively.",
1901 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06001902 }
1903
1904 // VUID-VkImageCopy-dstImage-01788
1905 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
1906 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 -06001907 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001908 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
1909 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001910 }
1911
1912 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001913 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001914 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 -06001915 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001916 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001917 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1918 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001919 }
1920 }
1921 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001922 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001923 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001924 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001925 skip |=
1926 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001927 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001928 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001929 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1930 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001931 }
1932 }
1933 } else { // Pre maint 1
1934 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001935 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001936 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 -06001937 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01001938 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1939 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001940 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1941 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001942 }
1943 }
1944 }
1945
Dave Houltonc991cc92018-03-06 11:08:51 -07001946 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1947 if (FormatIsCompressed(dst_state->createInfo.format) ||
1948 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001949 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001950
1951 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001952 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1953 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1954 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001955 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001956 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 -07001957 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001958 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001959 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001960 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001961 }
1962
Dave Houlton94a00372017-12-14 15:08:47 -07001963 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001964 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1965 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001966 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07001967 skip |=
1968 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001969 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001970 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001971 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001972 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001973 }
1974
Dave Houltonee281a52017-12-08 13:51:02 -07001975 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1976 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1977 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001978 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07001979 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 -07001980 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001981 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1982 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07001983 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001984 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001985 }
1986
Dave Houltonee281a52017-12-08 13:51:02 -07001987 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1988 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1989 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001990 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07001991 skip |=
1992 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001993 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001994 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001995 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001996 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001997 }
1998 } // Compressed
1999 }
2000 return skip;
2001}
2002
Dave Houltonc991cc92018-03-06 11:08:51 -07002003// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2004bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2005 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2006 bool skip = false;
2007 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2008
2009 // Neither image is multiplane
2010 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2011 // If neither image is multi-plane the aspectMask member of src and dst must match
2012 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2013 std::stringstream ss;
2014 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
2015 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2016 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 -06002017 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002018 }
2019 } else {
2020 // Source image multiplane checks
2021 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2022 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2023 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2024 std::stringstream ss;
2025 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2026 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 -06002027 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002028 }
2029 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2030 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2031 std::stringstream ss;
2032 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2033 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 -06002034 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002035 }
2036 // Single-plane to multi-plane
2037 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2038 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2039 std::stringstream ss;
2040 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2041 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 -06002042 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002043 }
2044
2045 // Dest image multiplane checks
2046 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2047 aspect = region.dstSubresource.aspectMask;
2048 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2049 std::stringstream ss;
2050 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2051 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 -06002052 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002053 }
2054 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2055 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2056 std::stringstream ss;
2057 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2058 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 -06002059 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002060 }
2061 // Multi-plane to single-plane
2062 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2063 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2064 std::stringstream ss;
2065 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2066 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 -06002067 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002068 }
2069 }
2070
2071 return skip;
2072}
2073
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002074bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002075 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2076 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002077 bool skip = false;
2078 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002079 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
2080
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002081 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2082
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002083 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002084 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002085
2086 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2087 VkExtent3D src_copy_extent = region.extent;
2088 VkExtent3D dst_copy_extent =
2089 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2090
Dave Houlton6f9059e2017-05-02 17:15:13 -06002091 bool slice_override = false;
2092 uint32_t depth_slices = 0;
2093
2094 // Special case for copying between a 1D/2D array and a 3D image
2095 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2096 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2097 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002098 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002099 slice_override = (depth_slices != 1);
2100 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2101 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002102 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002103 slice_override = (depth_slices != 1);
2104 }
2105
Cort Strattond619a302018-05-17 19:46:32 -07002106 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2107 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002108 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2109 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2110 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2111 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2112 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2113 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2114 "VUID-vkCmdCopyImage-srcSubresource-01698");
2115 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2116 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2117 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002118
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002119 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002120 // No chance of mismatch if we're overriding depth slice count
2121 if (!slice_override) {
2122 // The number of depth slices in srcSubresource and dstSubresource must match
2123 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2124 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002125 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2126 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002127 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002128 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2129 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002130 if (src_slices != dst_slices) {
2131 std::stringstream ss;
2132 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
2133 << "] do not match";
2134 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 -06002135 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002136 }
2137 }
2138 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002139 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002140 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002141 std::stringstream ss;
2142 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
2143 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002144 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 -06002145 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002146 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002147 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002148
Dave Houltonc991cc92018-03-06 11:08:51 -07002149 // Do multiplane-specific checks, if extension enabled
2150 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2151 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2152 }
2153
Dave Houltonf5217612018-02-02 16:18:52 -07002154 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2155 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2156 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2157 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
2158 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 -06002159 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002160 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002161 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002162
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002163 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002164 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002165 std::stringstream ss;
2166 ss << "vkCmdCopyImage: pRegion[" << i
2167 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2168 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 -06002169 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002170 }
2171
2172 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002173 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002174 std::stringstream ss;
2175 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2176 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 -06002177 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002178 }
2179
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002180 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2181 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2182 // 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 -07002183 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2184 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002185 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002186 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
2187 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2188 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2189 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002190 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 -06002191 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002192 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002193
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002194 // 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 -07002195 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2196 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002197 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002198 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2199 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2200 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2201 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002202 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 -06002203 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002204 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002205 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002206
Dave Houltonfc1a4052017-04-27 14:32:45 -06002207 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002208 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2209 if (slice_override) src_copy_extent.depth = depth_slices;
2210 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002211 if (extent_check & x_bit) {
2212 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 -06002213 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002214 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002215 "width [%1d].",
2216 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002217 }
2218
2219 if (extent_check & y_bit) {
2220 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 -06002221 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002222 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002223 "height [%1d].",
2224 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002225 }
2226 if (extent_check & z_bit) {
2227 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 -06002228 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002229 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002230 "depth [%1d].",
2231 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002232 }
2233
Dave Houltonee281a52017-12-08 13:51:02 -07002234 // Adjust dest extent if necessary
2235 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2236 if (slice_override) dst_copy_extent.depth = depth_slices;
2237
2238 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002239 if (extent_check & x_bit) {
2240 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 -06002241 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002242 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002243 "width [%1d].",
2244 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002245 }
2246 if (extent_check & y_bit) {
2247 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 -06002248 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002249 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002250 "height [%1d].",
2251 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002252 }
2253 if (extent_check & z_bit) {
2254 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 -06002255 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002256 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002257 "depth [%1d].",
2258 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002259 }
2260
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002261 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2262 // must not overlap in memory
2263 if (src_image_state->image == dst_image_state->image) {
2264 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002265 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2266 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002267 std::stringstream ss;
2268 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2269 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 -06002270 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002271 }
2272 }
2273 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002274 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002275
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002276 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2277 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2278 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002279 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002280 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2281 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002282 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 -06002283 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002284 }
2285 } else {
Tony-LunarG7482ca92018-10-01 14:20:22 -06002286 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, region_count, regions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002287 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2288 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 -06002289 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002290 }
2291 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002292
Dave Houlton33c22b72017-02-28 13:16:02 -07002293 // Source and dest image sample counts must match
2294 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2295 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2296 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 -06002297 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002298 }
2299
Dave Houltond8ed0212018-05-16 17:18:24 -06002300 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2301 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002302 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002303 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2304 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2305 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2306 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002307 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002308 skip |=
2309 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002310 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002311 skip |=
2312 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002313 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002314 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002315 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002316 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2317 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002318 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002319 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002320 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07002321 const std::string invalid_src_layout_vuid =
2322 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2323 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2324 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2325 const std::string invalid_dst_layout_vuid =
2326 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2327 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2328 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002329 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002330 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002331 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2332 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002333 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002334 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2335 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2337 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002338 }
2339
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002340 return skip;
2341}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002342
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002343void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002344 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2345 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2346 // Make sure that all image slices are updated to correct layout
2347 for (uint32_t i = 0; i < region_count; ++i) {
2348 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2349 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2350 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002351 // Update bindings between images and cmd buffer
2352 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2353 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002354}
2355
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002356// Returns true if sub_rect is entirely contained within rect
2357static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2358 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2359 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2360 return false;
2361 return true;
2362}
2363
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002364bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2365 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002366 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002367 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2368
2369 bool skip = false;
2370 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002371 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002372 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002373 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002374 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002375 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002376 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2377 // 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 -07002378 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2379 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002380 skip |= log_msg(
2381 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002382 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002383 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2384 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2385 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002386 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002387 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002388 }
2389
2390 // Validate that attachment is in reference list of active subpass
2391 if (cb_node->activeRenderPass) {
2392 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2393 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002394 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002395
2396 for (uint32_t i = 0; i < attachmentCount; i++) {
2397 auto clear_desc = &pAttachments[i];
2398 VkImageView image_view = VK_NULL_HANDLE;
2399
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002400 if (0 == clear_desc->aspectMask) {
2401 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 -06002402 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002403 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2404 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 -06002405 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002406 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002407 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002408 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 -06002409 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-00015",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002410 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d.",
2411 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002412 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2413 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002414 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06002415 kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002416 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2417 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002418 } else {
2419 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002420 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002421 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002422 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2423 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2424 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002425 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002426 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002427 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002428 }
2429 } else { // Must be depth and/or stencil
2430 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2431 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002432 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002433 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 -06002434 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002435 }
2436 if (!subpass_desc->pDepthStencilAttachment ||
2437 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2438 skip |= log_msg(
2439 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002440 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002441 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002442 } else {
2443 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2444 }
2445 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002446 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002447 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002448 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002449 // The rectangular region specified by a given element of pRects must be contained within the render area of
2450 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002451 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2452 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2453 skip |=
2454 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 -06002455 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002456 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002457 "the current render pass instance.",
2458 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002459 }
2460 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002461 const auto local_rect =
2462 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002463 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002464 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002465 return log_msg(
2466 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002467 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002468 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002469 "the current render pass instance.",
2470 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002471 }
2472 return false;
2473 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002474 }
2475 // The layers specified by a given element of pRects must be contained within every attachment that
2476 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002477 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002478 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2479 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002480 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 -06002481 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00017",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002482 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002483 "of pAttachment[%d].",
2484 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002485 }
2486 }
2487 }
2488 }
2489 }
2490 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002491}
2492
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002493bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Cort Stratton7df30962018-05-17 19:45:57 -07002494 VkImageLayout src_image_layout, IMAGE_STATE *dst_image_state, VkImageLayout dst_image_layout,
2495 uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002496 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002497 bool skip = false;
2498 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002499 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2500 "VUID-vkCmdResolveImage-srcImage-00256");
2501 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2502 "VUID-vkCmdResolveImage-dstImage-00258");
2503 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2504 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002505 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002506 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002507 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002508 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2509 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002510
Cort Stratton7df30962018-05-17 19:45:57 -07002511 bool hit_error = false;
2512 const std::string invalid_src_layout_vuid =
2513 (src_image_state->shared_presentable &&
2514 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2515 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2516 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2517 const std::string invalid_dst_layout_vuid =
2518 (dst_image_state->shared_presentable &&
2519 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2520 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2521 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002522 // For each region, the number of layers in the image subresource should not be zero
2523 // For each region, src and dest image aspect must be color only
2524 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002525 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2526 "srcSubresource", i);
2527 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2528 "dstSubresource", i);
Cort Stratton7df30962018-05-17 19:45:57 -07002529 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, src_image_layout,
2530 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2531 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
2532 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dst_image_layout,
2533 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2534 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002535 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2536 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2537 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2538 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2539 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2540 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2541 "VUID-vkCmdResolveImage-srcSubresource-01711");
2542 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2543 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2544 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002545
2546 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002547 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2548 skip |= log_msg(
2549 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(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002551 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002552 }
Cort Stratton7df30962018-05-17 19:45:57 -07002553 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002554 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2555 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2556 char const str[] =
2557 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2558 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 -06002559 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002560 }
2561 }
2562
2563 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2564 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002565 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 -06002566 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002567 }
2568 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2569 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002570 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 -06002571 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002572 }
2573 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2574 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2575 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 -06002576 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002577 }
2578 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2579 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2580 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 -06002581 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002582 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002583 } else {
2584 assert(0);
2585 }
2586 return skip;
2587}
2588
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002589void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2590 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002591 // Update bindings between images and cmd buffer
2592 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2593 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002594}
2595
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002596bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002597 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2598 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002599 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2600
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002601 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002602 if (cb_node) {
2603 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2604 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002605 if (cb_node && src_image_state && dst_image_state) {
2606 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002607 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002608 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002609 "VUID-vkCmdBlitImage-dstImage-00234");
2610 skip |=
2611 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2612 skip |=
2613 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
2614 skip |=
2615 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2616 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2617 skip |=
2618 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2619 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2620 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
2621 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002622 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002623 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002624 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002625 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04002626 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002627 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002628
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002629 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002630
Dave Houlton33c2d252017-06-09 17:08:32 -06002631 VkFormat src_format = src_image_state->createInfo.format;
2632 VkFormat dst_format = dst_image_state->createInfo.format;
2633 VkImageType src_type = src_image_state->createInfo.imageType;
2634 VkImageType dst_type = dst_image_state->createInfo.imageType;
2635
Cort Stratton186b1a22018-05-01 20:18:06 -04002636 if (VK_FILTER_LINEAR == filter) {
2637 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002638 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2639 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002640 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002641 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
2642 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002643 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002644 }
2645
2646 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2647 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 -06002648 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002649 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002650 }
2651
Dave Houlton33c2d252017-06-09 17:08:32 -06002652 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2653 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2654 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 -06002655 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002656 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002657 }
2658
2659 // Validate consistency for unsigned formats
2660 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2661 std::stringstream ss;
2662 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2663 << "the other one must also have unsigned integer format. "
2664 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2665 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 -06002666 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002667 }
2668
2669 // Validate consistency for signed formats
2670 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2671 std::stringstream ss;
2672 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2673 << "the other one must also have signed integer format. "
2674 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2675 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 -06002676 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002677 }
2678
2679 // Validate filter for Depth/Stencil formats
2680 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2681 std::stringstream ss;
2682 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2683 << "then filter must be VK_FILTER_NEAREST.";
2684 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 -06002685 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002686 }
2687
2688 // Validate aspect bits and formats for depth/stencil images
2689 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2690 if (src_format != dst_format) {
2691 std::stringstream ss;
2692 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2693 << "stencil, the other one must have exactly the same format. "
2694 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2695 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06002696 skip |=
2697 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2698 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002699 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002700 } // Depth or Stencil
2701
2702 // Do per-region checks
Cort Stratton7df30962018-05-17 19:45:57 -07002703 const std::string invalid_src_layout_vuid =
2704 (src_image_state->shared_presentable &&
2705 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2706 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
2707 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
2708 const std::string invalid_dst_layout_vuid =
2709 (dst_image_state->shared_presentable &&
2710 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2711 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
2712 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002713 for (uint32_t i = 0; i < region_count; i++) {
2714 const VkImageBlit rgn = regions[i];
2715 bool hit_error = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06002716 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002717 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
2718 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Dave Houltond8ed0212018-05-16 17:18:24 -06002719 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002720 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
2721 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07002722 skip |=
2723 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
2724 skip |=
2725 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002726 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
2727 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
2728 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
2729 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
2730 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
2731 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
2732 "VUID-vkCmdBlitImage-srcSubresource-01707");
2733 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
2734 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
2735 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002736 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002737 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2738 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002739 std::stringstream ss;
2740 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06002741 skip |=
2742 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2743 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002744 }
Dave Houlton48989f32017-05-26 15:01:46 -06002745 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2746 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002747 std::stringstream ss;
2748 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06002749 skip |=
2750 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2751 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002752 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002753
2754 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002755 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002756 skip |=
2757 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 -06002758 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002759 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002760 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002761
Dave Houlton48989f32017-05-26 15:01:46 -06002762 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002763 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 -06002764 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002765 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002766 }
Dave Houlton48989f32017-05-26 15:01:46 -06002767
Dave Houlton33c2d252017-06-09 17:08:32 -06002768 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2769 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002770 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Dave Houlton33c2d252017-06-09 17:08:32 -06002771 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002772 "image format %s.",
2773 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002774 }
2775
2776 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2777 skip |= log_msg(
2778 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002779 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002780 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
2781 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002782 }
2783
Dave Houlton48989f32017-05-26 15:01:46 -06002784 // Validate source image offsets
2785 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002786 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002787 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2788 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 -06002789 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
Dave Houlton48989f32017-05-26 15:01:46 -06002790 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002791 "of (%1d, %1d). These must be (0, 1).",
2792 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002793 }
2794 }
2795
Dave Houlton33c2d252017-06-09 17:08:32 -06002796 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002797 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2798 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 -06002799 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Dave Houlton48989f32017-05-26 15:01:46 -06002800 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002801 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
2802 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002803 }
2804 }
2805
Dave Houlton33c2d252017-06-09 17:08:32 -06002806 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002807 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2808 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002809 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002810 skip |=
2811 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 -06002812 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002813 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
2814 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002815 }
2816 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2817 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002818 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002819 skip |= log_msg(
2820 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002821 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002822 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
2823 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002824 }
2825 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2826 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002827 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002828 skip |=
2829 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 -06002830 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002831 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
2832 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002833 }
Cort Strattonff1542a2018-05-27 10:49:28 -07002834 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002835 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 -06002836 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002837 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06002838 }
Dave Houlton48989f32017-05-26 15:01:46 -06002839
2840 // Validate dest image offsets
2841 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002842 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002843 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2844 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 -06002845 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
Dave Houlton48989f32017-05-26 15:01:46 -06002846 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002847 "(%1d, %1d). These must be (0, 1).",
2848 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002849 }
2850 }
2851
Dave Houlton33c2d252017-06-09 17:08:32 -06002852 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002853 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2854 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 -06002855 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Dave Houlton48989f32017-05-26 15:01:46 -06002856 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002857 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
2858 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002859 }
2860 }
2861
Dave Houlton33c2d252017-06-09 17:08:32 -06002862 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002863 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2864 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002865 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002866 skip |=
2867 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 -06002868 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002869 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
2870 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002871 }
2872 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2873 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002874 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002875 skip |= log_msg(
2876 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002877 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002878 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
2879 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002880 }
2881 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2882 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002883 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002884 skip |=
2885 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 -06002886 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002887 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
2888 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002889 }
Cort Strattonff1542a2018-05-27 10:49:28 -07002890 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002891 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-vkCmdBlitImage-pRegions-00216",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002893 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002894 }
2895
Dave Houlton33c2d252017-06-09 17:08:32 -06002896 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2897 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2898 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2899 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 -06002900 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
Dave Houlton33c2d252017-06-09 17:08:32 -06002901 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002902 "layerCount other than 1.",
2903 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002904 }
2905 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002906 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002907 } else {
2908 assert(0);
2909 }
2910 return skip;
2911}
2912
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002913void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002914 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2915 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2916 // Make sure that all image slices are updated to correct layout
2917 for (uint32_t i = 0; i < region_count; ++i) {
2918 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2919 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2920 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002921 // Update bindings between images and cmd buffer
2922 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2923 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002924}
2925
Tony Barbourdf013b92017-01-25 12:53:48 -07002926// This validates that the initial layout specified in the command buffer for
2927// the IMAGE is the same
2928// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002929bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002930 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2931 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002932 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002933 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002934 for (auto cb_image_data : pCB->imageLayoutMap) {
2935 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002936
Dave Houltonb3f4b282018-02-22 16:25:16 -07002937 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2938 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002939 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2940 // TODO: Set memory invalid which is in mem_tracker currently
2941 } else if (imageLayout != cb_image_data.second.initialLayout) {
2942 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002943 skip |= log_msg(
2944 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002945 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002946 "Cannot submit cmd buffer using image (0x%" PRIx64
2947 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2948 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2949 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2950 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002951 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002952 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 -06002953 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002954 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002955 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2956 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002957 }
2958 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002959 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002960 }
2961 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002962 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002963}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002964
Tony Barbourdf013b92017-01-25 12:53:48 -07002965void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2966 for (auto cb_image_data : pCB->imageLayoutMap) {
2967 VkImageLayout imageLayout;
2968 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2969 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2970 }
2971}
2972
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002973// Print readable FlagBits in FlagMask
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002974static std::string StringVkAccessFlags(VkAccessFlags accessMask) {
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002975 std::string result;
2976 std::string separator;
2977
2978 if (accessMask == 0) {
2979 result = "[None]";
2980 } else {
2981 result = "[";
2982 for (auto i = 0; i < 32; i++) {
2983 if (accessMask & (1 << i)) {
2984 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2985 separator = " | ";
2986 }
2987 }
2988 result = result + "]";
2989 }
2990 return result;
2991}
2992
Dave Houlton12befb92018-06-26 17:16:46 -06002993#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 -06002994 // validation ToBeRemoved (disabled 6/18)
Dave Houlton12befb92018-06-26 17:16:46 -06002995
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002996// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2997// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002998// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002999static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
3000 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
3001 const char *type) {
3002 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3003 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003004
3005 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
3006 if (accessMask & ~(required_bit | optional_bits)) {
3007 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003008 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 -06003009 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003010 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003011 StringVkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003012 }
3013 } else {
3014 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003015 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 -06003016 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003017 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
3018 "has previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003019 type, accessMask, StringVkAccessFlags(accessMask).c_str(), optional_bits,
3020 StringVkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003021 } else {
3022 std::string opt_bits;
3023 if (optional_bits != 0) {
3024 std::stringstream ss;
3025 ss << optional_bits;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003026 opt_bits = "and may have optional bits " + ss.str() + ' ' + StringVkAccessFlags(optional_bits);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003027 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003028 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 -06003029 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003030 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
3031 "previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003032 type, accessMask, StringVkAccessFlags(accessMask).c_str(), required_bit,
3033 StringVkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003034 }
3035 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003036 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003037}
Dave Houlton12befb92018-06-26 17:16:46 -06003038#endif
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003039
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003040// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003041// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3042// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003043bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003044 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
3045 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003046 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3047 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3048 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3049 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003050 skip |=
3051 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3052 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3053 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003054 }
3055 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003056 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3057 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003058 skip |=
3059 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3060 "VUID-VkRenderPassCreateInfo-pAttachments-01566",
3061 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003062 }
3063 }
3064
3065 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3066 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003067 skip |=
3068 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3069 "VUID-VkRenderPassCreateInfo-pAttachments-01567",
3070 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003071 }
3072 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003073 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003074}
3075
John Zulauf7ec577a2018-06-08 17:00:13 -06003076bool ValidateLayouts(const core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003077 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003078 bool skip = false;
3079
Jason Ekstranda1906302017-12-03 20:16:32 -08003080 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3081 VkFormat format = pCreateInfo->pAttachments[i].format;
3082 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3083 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3084 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003085 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 -06003086 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003087 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3088 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3089 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3090 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003091 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003092 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003093 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 -06003094 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003095 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3096 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3097 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3098 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003099 }
3100 }
3101 }
3102
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003103 // Track when we're observing the first use of an attachment
3104 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3105 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
3106 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003107
3108 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3109 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3110 auto attach_index = subpass.pInputAttachments[j].attachment;
3111 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3112
3113 switch (subpass.pInputAttachments[j].layout) {
3114 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3115 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3116 // These are ideal.
3117 break;
3118
3119 case VK_IMAGE_LAYOUT_GENERAL:
3120 // May not be optimal. TODO: reconsider this warning based on other constraints.
3121 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003122 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003123 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3124 break;
3125
3126 default:
3127 // No other layouts are acceptable
3128 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 -06003129 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003130 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3131 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3132 }
3133
Cort Stratton7547f772017-05-04 15:18:52 -07003134 if (attach_first_use[attach_index]) {
3135 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
3136 pCreateInfo->pAttachments[attach_index]);
3137
3138 bool used_as_depth =
3139 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3140 bool used_as_color = false;
3141 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3142 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3143 }
3144 if (!used_as_depth && !used_as_color &&
3145 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3146 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003147 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06003148 "VUID-VkSubpassDescription-loadOp-00846",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003149 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3150 attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003151 }
3152 }
3153 attach_first_use[attach_index] = false;
3154 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003155 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3156 auto attach_index = subpass.pColorAttachments[j].attachment;
3157 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3158
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003159 // TODO: Need a way to validate shared presentable images here, currently just allowing
3160 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3161 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003162 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003163 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003164 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003165 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3166 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003167 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003168
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003169 case VK_IMAGE_LAYOUT_GENERAL:
3170 // May not be optimal; TODO: reconsider this warning based on other constraints?
3171 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003172 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003173 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3174 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003175
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003176 default:
3177 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 -06003178 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003179 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3180 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003181 }
3182
3183 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003184 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
3185 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003186 }
3187 attach_first_use[attach_index] = false;
3188 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003189
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003190 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3191 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003192 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3193 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3194 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003195 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003196
Dave Houltona9df0ce2018-02-07 10:51:23 -07003197 case VK_IMAGE_LAYOUT_GENERAL:
3198 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3199 // doing a bunch of transitions.
3200 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003201 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003202 "GENERAL layout for depth attachment may not give optimal performance.");
3203 break;
3204
3205 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3206 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3207 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3208 break;
3209 } else {
3210 // Intentionally fall through to generic error message
3211 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003212 // fall through
Dave Houltona9df0ce2018-02-07 10:51:23 -07003213 default:
3214 // No other layouts are acceptable
3215 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 -06003216 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003217 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3218 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3219 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003220 }
3221
3222 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3223 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003224 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
3225 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003226 }
3227 attach_first_use[attach_index] = false;
3228 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003229 }
3230 return skip;
3231}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003232
3233// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003234bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3235 VkDeviceSize offset, VkDeviceSize end_offset) {
3236 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3237 bool skip = false;
3238 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3239 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003240 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3241 for (auto image_handle : mem_info->bound_images) {
3242 auto img_it = mem_info->bound_ranges.find(image_handle);
3243 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003244 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003245 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003246 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003247 for (auto layout : layouts) {
3248 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003249 skip |=
3250 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 -06003251 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003252 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3253 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003254 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003255 }
3256 }
3257 }
3258 }
3259 }
3260 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003261 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003262}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003263
3264// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3265// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003266static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3267 VulkanObjectType obj_type, std::string msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003268 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003269
3270 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003271 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003272 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003273 if (strict) {
3274 correct_usage = ((actual & desired) == desired);
3275 } else {
3276 correct_usage = ((actual & desired) != 0);
3277 }
3278 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003279 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003280 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003281 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003282 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 -06003283 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003284 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3285 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003286 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003287 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003288 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 -06003289 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3290 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003291 }
3292 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003293 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003294}
3295
3296// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3297// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003298bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003299 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003300 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3301 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003302}
3303
Cort Stratton186b1a22018-05-01 20:18:06 -04003304bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Dave Houltone0969282018-05-23 15:54:31 -06003305 char const *func_name, const std::string &linear_vuid, const std::string &optimal_vuid) {
Cort Stratton186b1a22018-05-01 20:18:06 -04003306 VkFormatProperties format_properties = GetFormatProperties(dev_data, image_state->createInfo.format);
3307 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3308 bool skip = false;
3309 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3310 if ((format_properties.linearTilingFeatures & desired) != desired) {
3311 skip |=
3312 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3313 HandleToUint64(image_state->image), linear_vuid,
3314 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3315 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3316 }
3317 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3318 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3319 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3320 HandleToUint64(image_state->image), optimal_vuid,
3321 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3322 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3323 HandleToUint64(image_state->image));
3324 }
3325 }
3326 return skip;
3327}
3328
Cort Strattond619a302018-05-17 19:46:32 -07003329bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3330 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3331 uint32_t i) {
3332 bool skip = false;
3333 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3334 // layerCount must not be zero
3335 if (subresource_layers->layerCount == 0) {
3336 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3337 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3338 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3339 }
3340 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3341 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3342 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3343 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3344 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3345 }
3346 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3347 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3348 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3349 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3350 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3351 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3352 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3353 func_name, i, member);
3354 }
3355 return skip;
3356}
3357
Mark Lobodzinski96210742017-02-09 10:33:46 -07003358// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3359// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003360bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003361 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003362 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3363 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003364}
3365
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003366bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3367 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3368 bool skip = false;
3369 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3370
3371 const VkDeviceSize &range = pCreateInfo->range;
3372 if (range != VK_WHOLE_SIZE) {
3373 // Range must be greater than 0
3374 if (range <= 0) {
3375 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3376 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3377 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3378 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3379 range);
3380 }
3381 // Range must be a multiple of the element size of format
3382 const size_t format_size = FormatSize(pCreateInfo->format);
3383 if (range % format_size != 0) {
3384 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3385 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3386 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3387 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3388 "(" PRINTF_SIZE_T_SPECIFIER ").",
3389 range, format_size);
3390 }
3391 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3392 if (range / format_size > device_limits->maxTexelBufferElements) {
3393 skip |=
3394 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3395 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3396 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3397 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3398 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3399 range, format_size, device_limits->maxTexelBufferElements);
3400 }
3401 // The sum of range and offset must be less than or equal to the size of buffer
3402 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3403 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3404 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3405 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3406 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3407 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3408 range, pCreateInfo->offset, buffer_state->createInfo.size);
3409 }
3410 }
3411 return skip;
3412}
3413
Shannon McPherson265383a2018-06-21 15:37:52 -06003414bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3415 const VkBufferViewCreateInfo *pCreateInfo) {
3416 bool skip = false;
3417 const debug_report_data *report_data = GetReportData(device_data);
3418 const VkFormatProperties format_properties = GetFormatProperties(device_data, pCreateInfo->format);
3419 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3420 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3421 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3422 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3423 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3424 "be supported for uniform texel buffers");
3425 }
3426 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3427 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3428 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3429 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3430 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3431 "be supported for storage texel buffers");
3432 }
3433 return skip;
3434}
3435
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003436bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003437 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003438 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3439
Dave Houltond8ed0212018-05-16 17:18:24 -06003440 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003441
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003442 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003443 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 -06003444 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003445 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003446 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003447 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003448
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003449 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3450 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003451 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 -06003452 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003453 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003454 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003455 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003456
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003457 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3458 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003459 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 -06003460 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003461 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003462 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003463 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003464 return skip;
3465}
3466
3467void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3468 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3469 GetBufferMap(device_data)
3470 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3471}
3472
Shannon McPhersona84241a2018-06-18 15:34:46 -06003473bool PreCallValidateCreateBufferView(const layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003474 bool skip = false;
Shannon McPherson883f6092018-06-14 13:15:25 -06003475 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003476 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003477 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3478 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003479 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3480 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003481 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3482 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003483 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3484 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3485 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3486 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003487
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003488 // Buffer view offset must be less than the size of buffer
3489 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3490 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3491 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3492 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3493 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3494 pCreateInfo->offset, buffer_state->createInfo.size);
3495 }
3496
Shannon McPherson883f6092018-06-14 13:15:25 -06003497 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
3498 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3499 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3500 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3501 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3502 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3503 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3504 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3505 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003506
3507 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003508
3509 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003510 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003511 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003512}
3513
3514void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3515 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3516}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003517
3518// For the given format verify that the aspect masks make sense
3519bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3520 const char *func_name) {
3521 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3522 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003523 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003524 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003525 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 -06003526 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003527 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003528 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003529 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 -06003530 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003531 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003532 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003533 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003534 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003535 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 -06003536 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003537 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003538 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3539 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003540 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003541 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 -06003542 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003543 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003544 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3545 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003546 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003547 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003548 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003549 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 -06003550 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003551 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003552 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003553 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 -06003554 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003555 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003556 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003557 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003558 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003559 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 -06003560 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003561 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003562 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003563 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 -06003564 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003565 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003566 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003567 } else if (FormatIsMultiplane(format)) {
3568 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3569 if (3 == FormatPlaneCount(format)) {
3570 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3571 }
3572 if ((aspect_mask & valid_flags) != aspect_mask) {
3573 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 -06003574 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Dave Houlton501b15b2018-03-30 15:07:41 -06003575 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3576 "set, where n = [0, 1, 2].",
3577 func_name);
3578 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003579 }
3580 return skip;
3581}
3582
Petr Krausffa94af2017-08-08 21:46:02 +02003583struct SubresourceRangeErrorCodes {
Dave Houltond8ed0212018-05-16 17:18:24 -06003584 std::string base_mip_err, mip_count_err, base_layer_err, layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02003585};
3586
3587bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3588 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3589 const char *image_layer_count_var_name, const uint64_t image_handle,
3590 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003591 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3592 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003593
3594 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003595 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003596 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 -06003597 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003598 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003599 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3600 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003601 }
Petr Kraus4d718682017-05-18 03:38:41 +02003602
Petr Krausffa94af2017-08-08 21:46:02 +02003603 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3604 if (subresourceRange.levelCount == 0) {
3605 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 -06003606 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003607 } else {
3608 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003609
Petr Krausffa94af2017-08-08 21:46:02 +02003610 if (necessary_mip_count > image_mip_count) {
3611 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 -06003612 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003613 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003614 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003615 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003616 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003617 }
Petr Kraus4d718682017-05-18 03:38:41 +02003618 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003619 }
Petr Kraus4d718682017-05-18 03:38:41 +02003620
3621 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003622 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003623 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 -06003624 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003625 "%s: %s.baseArrayLayer (= %" PRIu32
3626 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3627 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003628 }
Petr Kraus4d718682017-05-18 03:38:41 +02003629
Petr Krausffa94af2017-08-08 21:46:02 +02003630 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3631 if (subresourceRange.layerCount == 0) {
3632 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 -06003633 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003634 } else {
3635 const uint64_t necessary_layer_count =
3636 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003637
Petr Krausffa94af2017-08-08 21:46:02 +02003638 if (necessary_layer_count > image_layer_count) {
3639 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 -06003640 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003641 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003642 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003643 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003644 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003645 }
Petr Kraus4d718682017-05-18 03:38:41 +02003646 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003647 }
Petr Kraus4d718682017-05-18 03:38:41 +02003648
Mark Lobodzinski602de982017-02-09 11:01:33 -07003649 return skip;
3650}
3651
Petr Krausffa94af2017-08-08 21:46:02 +02003652bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3653 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3654 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3655 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3656 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3657 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3658
3659 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3660 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3661
3662 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003663 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
3664 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
3665 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
3666 : "VUID-VkImageViewCreateInfo-image-01482")
3667 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
3668 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
3669 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
3670 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
3671 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02003672
3673 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3674 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3675 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3676}
3677
3678bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3679 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3680 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003681 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
3682 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
3683 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
3684 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02003685
3686 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3687 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3688 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3689}
3690
3691bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3692 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3693 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003694 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
3695 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
3696 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
3697 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02003698
3699 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3700 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3701 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3702}
3703
3704bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3705 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3706 const char *param_name) {
3707 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003708 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
3709 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
3710 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
3711 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02003712
3713 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3714 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3715 subresourceRangeErrorCodes);
3716}
3717
Mark Lobodzinski602de982017-02-09 11:01:33 -07003718bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3719 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3720 bool skip = false;
3721 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3722 if (image_state) {
3723 skip |= ValidateImageUsageFlags(
3724 device_data, image_state,
3725 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Jeff Bolz9af91c52018-09-01 21:53:57 -05003726 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06003727 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05003728 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07003729 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06003730 skip |=
3731 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07003732 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003733 skip |= ValidateCreateImageViewSubresourceRange(
3734 device_data, image_state,
3735 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3736 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003737
3738 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3739 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003740 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3741 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003742 VkFormat view_format = create_info->format;
3743 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003744 VkImageType image_type = image_state->createInfo.imageType;
3745 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003746
Dave Houltonbd2e2622018-04-10 16:41:14 -06003747 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
3748 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
3749 if (chained_ivuci_struct) {
3750 if (chained_ivuci_struct->usage & ~image_usage) {
3751 std::stringstream ss;
3752 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06003753 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06003754 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06003755 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3756 HandleToUint64(create_info->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
3757 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06003758 }
3759
3760 image_usage = chained_ivuci_struct->usage;
3761 }
3762
Dave Houlton6f5f20a2018-05-04 12:37:44 -06003763 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
3764 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06003765 if (FormatIsMultiplane(image_format)) {
3766 // View format must match the multiplane compatible format
3767 uint32_t plane = 3; // invalid
3768 switch (aspect_mask) {
3769 case VK_IMAGE_ASPECT_PLANE_0_BIT:
3770 plane = 0;
3771 break;
3772 case VK_IMAGE_ASPECT_PLANE_1_BIT:
3773 plane = 1;
3774 break;
3775 case VK_IMAGE_ASPECT_PLANE_2_BIT:
3776 plane = 2;
3777 break;
3778 default:
3779 break;
3780 }
3781
3782 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
3783 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003784 std::stringstream ss;
3785 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06003786 << " is not compatible with plane " << plane << " of underlying image format "
3787 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06003788 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3789 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
3790 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06003791 }
3792 } else {
3793 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3794 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3795 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3796 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3797 std::stringstream ss;
3798 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3799 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3800 << ") format " << string_VkFormat(image_format)
3801 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3802 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06003803 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3804 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
3805 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06003806 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003807 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003808 }
3809 } else {
3810 // Format MUST be IDENTICAL to the format the image was created with
3811 if (image_format != view_format) {
3812 std::stringstream ss;
3813 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003814 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003815 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06003816 skip |=
3817 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3818 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07003819 }
3820 }
3821
3822 // Validate correct image aspect bits for desired formats and format consistency
3823 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003824
3825 switch (image_type) {
3826 case VK_IMAGE_TYPE_1D:
3827 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06003828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3829 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003830 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3831 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003832 }
3833 break;
3834 case VK_IMAGE_TYPE_2D:
3835 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3836 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3837 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003838 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3839 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003840 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3841 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003842 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06003843 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3844 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003845 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3846 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003847 }
3848 }
3849 break;
3850 case VK_IMAGE_TYPE_3D:
3851 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3852 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3853 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3854 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003855 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06003856 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3857 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003858 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3859 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003860 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3861 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003862 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06003863 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3864 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003865 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3866 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003867 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
3868 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003869 }
3870 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06003871 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3872 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003873 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3874 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003875 }
3876 }
3877 } else {
3878 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06003879 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3880 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003881 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3882 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003883 }
3884 }
3885 break;
3886 default:
3887 break;
3888 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003889
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003890 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003891 bool check_tiling_features = false;
3892 VkFormatFeatureFlags tiling_features = 0;
Dave Houltond8ed0212018-05-16 17:18:24 -06003893 std::string linear_error_codes[] = {
3894 "VUID-VkImageViewCreateInfo-image-01006", "VUID-VkImageViewCreateInfo-image-01008",
3895 "VUID-VkImageViewCreateInfo-image-01009", "VUID-VkImageViewCreateInfo-image-01010",
3896 "VUID-VkImageViewCreateInfo-image-01011",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003897 };
Dave Houltond8ed0212018-05-16 17:18:24 -06003898 std::string optimal_error_codes[] = {
3899 "VUID-VkImageViewCreateInfo-image-01012", "VUID-VkImageViewCreateInfo-image-01013",
3900 "VUID-VkImageViewCreateInfo-image-01014", "VUID-VkImageViewCreateInfo-image-01015",
3901 "VUID-VkImageViewCreateInfo-image-01016",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003902 };
Dave Houltond8ed0212018-05-16 17:18:24 -06003903 std::string *error_codes = nullptr;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003904 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003905 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003906 error_codes = linear_error_codes;
3907 check_tiling_features = true;
3908 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003909 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003910 error_codes = optimal_error_codes;
3911 check_tiling_features = true;
3912 }
3913
3914 if (check_tiling_features) {
3915 if (tiling_features == 0) {
Mark Young9d1ac312018-05-21 16:28:27 -06003916 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3917 HandleToUint64(create_info->image), error_codes[0],
3918 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set.",
3919 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003920 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003921 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3922 HandleToUint64(create_info->image), error_codes[1],
3923 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3924 "VK_IMAGE_USAGE_SAMPLED_BIT flags set.",
3925 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003926 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003927 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3928 HandleToUint64(create_info->image), error_codes[2],
3929 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3930 "VK_IMAGE_USAGE_STORAGE_BIT flags set.",
3931 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003932 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3933 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003934 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3935 HandleToUint64(create_info->image), error_codes[3],
3936 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3937 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set.",
3938 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003939 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3940 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003941 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3942 HandleToUint64(create_info->image), error_codes[4],
3943 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3944 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set.",
3945 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003946 }
3947 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05003948 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
3949 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3950 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3951 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02086",
3952 "vkCreateImageView() If image was created with usage containing "
3953 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
3954 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
3955 }
3956 if (view_format != VK_FORMAT_R8_UINT) {
3957 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3958 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02087",
3959 "vkCreateImageView() If image was created with usage containing "
3960 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
3961 }
3962 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003963 }
3964 return skip;
3965}
3966
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003967void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3968 auto image_view_map = GetImageViewMap(device_data);
3969 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3970
3971 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003972 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003973 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3974 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003975}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003976
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003977bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3978 BUFFER_STATE *dst_buffer_state) {
3979 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06003980 skip |=
3981 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
3982 skip |=
3983 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003984 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06003985 skip |=
3986 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3987 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3988 skip |=
3989 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3990 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003991 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06003992 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
3993 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003994 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003995 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003996 return skip;
3997}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003998
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003999void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4000 BUFFER_STATE *dst_buffer_state) {
4001 // Update bindings between buffers and cmd buffer
4002 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4003 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004004}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004005
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004006static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004007 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4008 bool skip = false;
4009 auto buffer_state = GetBufferState(device_data, buffer);
4010 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004011 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 -06004012 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01004013 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004014 } else {
4015 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004016 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 -06004017 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004018 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004019 }
4020 }
4021 return skip;
4022}
4023
4024bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
4025 VK_OBJECT *obj_struct) {
4026 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004027 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004028 if (GetDisables(device_data)->destroy_image_view) return false;
4029 bool skip = false;
4030 if (*image_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004031 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView",
4032 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004033 }
4034 return skip;
4035}
4036
John Zulauffca05c12018-04-26 16:30:39 -06004037void PreCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
4038 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004039 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004040 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004041 (*GetImageViewMap(device_data)).erase(image_view);
4042}
4043
4044bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
4045 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02004046 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004047 if (GetDisables(device_data)->destroy_buffer) return false;
4048 bool skip = false;
4049 if (*buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004050 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004051 }
4052 return skip;
4053}
4054
John Zulauffca05c12018-04-26 16:30:39 -06004055void PreCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004056 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004057 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4058 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4059 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004060 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004061 }
4062 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004063 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004064 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004065 GetBufferMap(device_data)->erase(buffer_state->buffer);
4066}
4067
4068bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
4069 VK_OBJECT *obj_struct) {
4070 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004071 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004072 if (GetDisables(device_data)->destroy_buffer_view) return false;
4073 bool skip = false;
4074 if (*buffer_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004075 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView",
4076 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004077 }
4078 return skip;
4079}
4080
John Zulauffca05c12018-04-26 16:30:39 -06004081void PreCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
4082 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004083 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004084 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004085 GetBufferViewMap(device_data)->erase(buffer_view);
4086}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004087
4088bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
4089 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004090 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004091 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004092 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4093 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004094 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4095 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004096 skip |=
4097 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4098 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004099 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004100 return skip;
4101}
4102
4103void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004104 // Update bindings between buffer and cmd buffer
4105 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004106}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004107
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004108bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4109 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004110 bool skip = false;
4111
4112 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004113 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4114 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004115 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 -06004116 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004117 "%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 -06004118 "and 1, respectively.",
4119 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004120 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004121 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004122
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004123 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4124 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004125 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 -06004126 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004127 "%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 -06004128 "must be 0 and 1, respectively.",
4129 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004130 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004131 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004132
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004133 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4134 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004135 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 -06004136 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004137 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4138 "For 3D images these must be 0 and 1, respectively.",
4139 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004140 }
4141 }
4142
4143 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
4144 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06004145 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06004146 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004147 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 -06004148 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004149 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004150 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
4151 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004152 }
4153
4154 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004155 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004156 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 -06004157 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004158 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4159 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004160 }
4161
4162 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4163 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004164 skip |=
4165 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004166 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004167 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4168 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004169 }
4170
4171 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4172 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4173 skip |= log_msg(
4174 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004175 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004176 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4177 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004178 }
4179
4180 // subresource aspectMask must have exactly 1 bit set
4181 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4182 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4183 if (aspect_mask_bits.count() != 1) {
4184 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 -06004185 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004186 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004187 }
4188
4189 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004190 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004191 skip |= log_msg(
4192 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004193 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004194 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4195 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004196 }
4197
4198 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004199 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004200 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004201
4202 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004203 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004204 skip |= log_msg(
4205 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004206 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004207 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4208 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004209 }
4210
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004211 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004212 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004213 skip |= log_msg(
4214 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004215 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004216 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4217 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004218 }
4219
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004220 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004221 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4222 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4223 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004224 skip |=
4225 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004226 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004227 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4228 "width & height (%d, %d)..",
4229 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004230 }
4231
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004232 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004233 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
4234 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004235 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 -06004236 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004237 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4238 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
4239 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004240 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004241
4242 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004243 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004244 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004245 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4246 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 -06004247 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004248 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004249 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004250 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004251 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004252 }
4253
4254 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004255 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004256 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4257 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 -06004258 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004259 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004260 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004261 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004262 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004263 }
4264
4265 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004266 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004267 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4268 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 -06004269 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004270 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004271 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004272 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004273 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004274 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004275 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004276 }
4277
4278 return skip;
4279}
4280
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004281static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Dave Houltond8ed0212018-05-16 17:18:24 -06004282 const VkBufferImageCopy *pRegions, const char *func_name, std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004283 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004284 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004285
4286 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004287 VkExtent3D extent = pRegions[i].imageExtent;
4288 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004289
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004290 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4291 {
Dave Houlton51653902018-06-22 17:32:13 -06004292 skip |=
4293 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4294 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4295 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004296 }
4297
4298 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4299
4300 // 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 -06004301 if (FormatIsCompressed(image_info->format)) {
4302 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004303 if (image_extent.width % block_extent.width) {
4304 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4305 }
4306 if (image_extent.height % block_extent.height) {
4307 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4308 }
4309 if (image_extent.depth % block_extent.depth) {
4310 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4311 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004312 }
4313
Dave Houltonfc1a4052017-04-27 14:32:45 -06004314 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004315 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 -06004316 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004317 }
4318 }
4319
4320 return skip;
4321}
4322
Chris Forbese8ba09a2017-06-01 17:39:02 -07004323static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004324 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06004325 std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004326 bool skip = false;
4327
4328 VkDeviceSize buffer_size = buff_state->createInfo.size;
4329
4330 for (uint32_t i = 0; i < regionCount; i++) {
4331 VkExtent3D copy_extent = pRegions[i].imageExtent;
4332
4333 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4334 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004335 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004336
Dave Houltonf3229d52017-02-21 15:59:08 -07004337 // Handle special buffer packing rules for specific depth/stencil formats
4338 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004339 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004340 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4341 switch (image_state->createInfo.format) {
4342 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004343 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004344 break;
4345 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004346 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004347 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004348 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004349 case VK_FORMAT_D24_UNORM_S8_UINT:
4350 unit_size = 4;
4351 break;
4352 default:
4353 break;
4354 }
4355 }
4356
Dave Houlton1d2022c2017-03-29 11:43:58 -06004357 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004358 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06004359 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004360 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4361 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4362
4363 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4364 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4365 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004366 }
4367
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004368 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4369 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4370 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004371 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004372 } else {
4373 // Calculate buffer offset of final copied byte, + 1.
4374 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4375 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4376 max_buffer_offset *= unit_size; // convert to bytes
4377 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004378
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004379 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004380 skip |=
4381 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4382 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004383 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004384 }
4385 }
4386
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004387 return skip;
4388}
4389
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004390bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004391 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004392 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004393 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4394 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4395
4396 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004397 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004398
4399 // Command pool must support graphics, compute, or transfer operations
4400 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4401
4402 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4403 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4404 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 -06004405 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004406 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004407 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004408 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004409 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004410 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004411 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004412 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004413
4414 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004415 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4416 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4417 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4418 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4419 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004420
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004421 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004422 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4423 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4424 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004425 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004426 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4427 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004428 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4429 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004430 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4431 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004432 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004433 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004434 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004435 const std::string src_invalid_layout_vuid =
4436 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4437 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4438 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004439 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004440 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4441 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004442 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004443 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4444 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004445 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004446 "vkCmdCopyImageToBuffer()",
4447 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004448 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4449 "vkCmdCopyImageToBuffer()", "imageSubresource",
4450 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4451 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4452 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4453 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004454 }
4455 return skip;
4456}
4457
4458void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004459 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4460 VkImageLayout src_image_layout) {
4461 // Make sure that all image slices are updated to correct layout
4462 for (uint32_t i = 0; i < region_count; ++i) {
4463 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4464 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004465 // Update bindings between buffer/image and cmd buffer
4466 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004467 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004468}
4469
4470bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004471 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004472 const VkBufferImageCopy *pRegions, const char *func_name) {
4473 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4474 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4475
4476 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004477 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004478
4479 // Command pool must support graphics, compute, or transfer operations
4480 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4481 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4482 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4483 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 -06004484 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004485 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004486 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004487 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004488 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004489 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004490 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004491 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004492 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004493 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4494 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4495 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4496 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4497 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004498 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004499 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4500 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4501 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4502 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4503 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004504 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4505 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004506 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4507 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004508 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004509 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004510 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004511 const std::string dst_invalid_layout_vuid =
4512 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4513 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4514 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004515 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004516 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4517 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004518 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004519 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4520 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004521 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004522 "vkCmdCopyBufferToImage()",
4523 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004524 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4525 "vkCmdCopyBufferToImage()", "imageSubresource",
4526 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4527 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4528 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4529 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004530 }
4531 return skip;
4532}
4533
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004534void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004535 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4536 VkImageLayout dst_image_layout) {
4537 // Make sure that all image slices are updated to correct layout
4538 for (uint32_t i = 0; i < region_count; ++i) {
4539 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4540 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004541 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004542 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004543}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004544
4545bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4546 const auto report_data = core_validation::GetReportData(device_data);
4547 bool skip = false;
4548 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4549
Dave Houlton1d960ff2018-01-19 12:17:05 -07004550 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004551 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4552 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4553 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004554 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 -06004555 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004556 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004557 }
4558
4559 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4560 if (!image_entry) {
4561 return skip;
4562 }
4563
Dave Houlton1d960ff2018-01-19 12:17:05 -07004564 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004565 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004566 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4567 "VUID-vkGetImageSubresourceLayout-image-00996",
4568 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004569 }
4570
Dave Houlton1d960ff2018-01-19 12:17:05 -07004571 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004572 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004573 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4574 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4575 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4576 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004577 }
4578
Dave Houlton1d960ff2018-01-19 12:17:05 -07004579 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004580 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004581 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4582 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4583 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4584 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004585 }
4586
Dave Houlton1d960ff2018-01-19 12:17:05 -07004587 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004588 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004589 if (FormatIsMultiplane(img_format)) {
4590 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Dave Houltond8ed0212018-05-16 17:18:24 -06004591 std::string vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004592 if (FormatPlaneCount(img_format) > 2u) {
4593 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004594 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004595 }
4596 if (sub_aspect != (sub_aspect & allowed_flags)) {
4597 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 -06004598 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004599 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004600 ") must be a single-plane specifier flag.",
4601 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004602 }
4603 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004604 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004605 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004606 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004607 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004608 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004609 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004610 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004611 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -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), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004614 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004615 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004616 }
4617 }
4618 return skip;
4619}