blob: ea50c8416832ace1ebd2626e983b71f91c557d6d [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
Tobias Hectorbbb12282018-10-22 15:17:59 +0100322bool ValidateRenderPassLayoutAgainstFramebufferImageUsage(layer_data *device_data, RenderPassCreateVersion rp_version,
323 VkImageLayout layout, VkImage image, VkImageView image_view,
324 VkFramebuffer framebuffer, VkRenderPass renderpass,
325 uint32_t attachment_index, const char *variable_name) {
326 bool skip = false;
327 const auto report_data = core_validation::GetReportData(device_data);
328 auto image_state = GetImageState(device_data, image);
329 const char *vuid;
330 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
331
332 if (!image_state) {
333 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
334 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
335 "Render Pass begin with renderpass 0x%" PRIx64 " uses framebuffer 0x%" PRIx64 " where pAttachments[%" PRIu32
336 "] = image view 0x%" PRIx64 ", which refers to an invalid image",
337 HandleToUint64(renderpass), HandleToUint64(framebuffer), attachment_index, HandleToUint64(image_view));
338 return skip;
339 }
340
341 auto image_usage = image_state->createInfo.usage;
342
343 // Check for layouts that mismatch image usages in the framebuffer
344 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
345 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
346 skip |=
347 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
348 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
349 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
350 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
351 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
352 HandleToUint64(renderpass), HandleToUint64(image_view));
353 }
354
355 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
356 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
357 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
358 skip |=
359 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
360 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
361 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
362 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
363 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
364 HandleToUint64(renderpass), HandleToUint64(image_view));
365 }
366
367 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
368 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
369 skip |=
370 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
371 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
372 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
373 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
374 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
375 HandleToUint64(renderpass), HandleToUint64(image_view));
376 }
377
378 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
379 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
380 skip |=
381 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
382 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
383 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
384 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
385 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
386 HandleToUint64(renderpass), HandleToUint64(image_view));
387 }
388
389 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
390 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
391 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
392 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
393 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
394 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
395 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
396 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
397 HandleToUint64(image), vuid,
398 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
399 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
400 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
401 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
402 HandleToUint64(renderpass), HandleToUint64(image_view));
403 }
404 } else {
405 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
406 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
407 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
408 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
409 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
410 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
411 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
412 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
413 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
414 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
415 HandleToUint64(renderpass), HandleToUint64(image_view));
416 }
417 }
418 return skip;
419}
420
421bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700422 const VkRenderPassBeginInfo *pRenderPassBegin,
423 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600424 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700425 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700426 auto const &framebufferInfo = framebuffer_state->createInfo;
427 const auto report_data = core_validation::GetReportData(device_data);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100428
429 auto render_pass = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->renderPass;
430 auto framebuffer = framebuffer_state->framebuffer;
431
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700432 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600433 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 -0600434 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700435 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700436 }
437 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
438 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700439 auto view_state = GetImageViewState(device_data, image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600440
441 if (!view_state) {
442 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
443 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
444 "vkCmdBeginRenderPass() :framebuffer 0x%" PRIx64 " pAttachments[%" PRIu32 "] = 0x%" PRIx64
445 " is not a valid VkImageView handle",
446 HandleToUint64(framebuffer_state->framebuffer), i, HandleToUint64(image_view));
447 continue;
448 }
449
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700450 const VkImage &image = view_state->create_info.image;
451 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700452 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100453 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
454
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700455 // TODO: Do not iterate over every possibility - consolidate where possible
456 for (uint32_t j = 0; j < subRange.levelCount; j++) {
457 uint32_t level = subRange.baseMipLevel + j;
458 for (uint32_t k = 0; k < subRange.layerCount; k++) {
459 uint32_t layer = subRange.baseArrayLayer + k;
460 VkImageSubresource sub = {subRange.aspectMask, level, layer};
461 IMAGE_CMD_BUF_LAYOUT_NODE node;
462 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700463 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700464 continue;
465 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700466 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600467 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 -0600468 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700469 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
470 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
471 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600472 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700473 }
474 }
475 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100476
477 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, initial_layout, image, image_view,
478 framebuffer, render_pass, i, "initial layout");
479
480 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, final_layout, image, image_view, framebuffer,
481 render_pass, i, "final layout");
482 }
483
484 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
485 auto &subpass = pRenderPassInfo->pSubpasses[j];
486 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
487 auto &attachment_ref = subpass.pInputAttachments[k];
488 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
489 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
490 auto view_state = GetImageViewState(device_data, image_view);
491
492 if (view_state) {
493 auto image = view_state->create_info.image;
494 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
495 image_view, framebuffer, render_pass,
496 attachment_ref.attachment, "input attachment layout");
497 }
498 }
499 }
500
501 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
502 auto &attachment_ref = subpass.pColorAttachments[k];
503 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
504 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
505 auto view_state = GetImageViewState(device_data, image_view);
506
507 if (view_state) {
508 auto image = view_state->create_info.image;
509 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
510 image_view, framebuffer, render_pass,
511 attachment_ref.attachment, "color attachment layout");
512 if (subpass.pResolveAttachments) {
513 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
514 device_data, rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
515 attachment_ref.attachment, "resolve attachment layout");
516 }
517 }
518 }
519 }
520
521 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
522 auto &attachment_ref = *subpass.pDepthStencilAttachment;
523 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
524 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
525 auto view_state = GetImageViewState(device_data, image_view);
526
527 if (view_state) {
528 auto image = view_state->create_info.image;
529 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
530 image_view, framebuffer, render_pass,
531 attachment_ref.attachment, "input attachment layout");
532 }
533 }
534 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700535 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600536 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700537}
538
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700539void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Tobias Hectorbbb12282018-10-22 15:17:59 +0100540 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700541 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf8e308292018-09-21 11:34:37 -0600542 auto image_view = GetAttachmentImageViewState(device_data, pFramebuffer, ref.attachment);
543 if (image_view) {
544 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
545 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700546 }
547}
548
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700549void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700550 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700551 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700552
553 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700554 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700555 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
556 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
557 }
558 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
559 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
560 }
561 if (subpass.pDepthStencilAttachment) {
562 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
563 }
564 }
565}
566
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600567bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700568 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700569 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
570 return false;
571 }
572 VkImageSubresource sub = {aspect, level, layer};
573 IMAGE_CMD_BUF_LAYOUT_NODE node;
574 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 return false;
576 }
577 bool skip = false;
578 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
579 // TODO: Set memory invalid which is in mem_tracker currently
580 } else if (node.layout != mem_barrier->oldLayout) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600581 skip = log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
582 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
583 "VUID-VkImageMemoryBarrier-oldLayout-01197",
584 "For image 0x%" PRIx64
585 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
586 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
587 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700588 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700589 return skip;
590}
591
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700592// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
593// 1. Transition into initialLayout state
594// 2. Transition from initialLayout to layout used in subpass 0
595void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
596 FRAMEBUFFER_STATE *framebuffer_state) {
597 // First transition into initialLayout
598 auto const rpci = render_pass_state->createInfo.ptr();
599 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -0600600 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
601 if (view_state) {
602 SetImageViewLayout(device_data, cb_state, view_state, rpci->pAttachments[i].initialLayout);
603 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700604 }
605 // Now transition for first subpass (index 0)
606 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
607}
608
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700609void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
Tony-LunarG0d27b302018-10-08 09:26:21 -0600610 uint32_t level, uint32_t layer, VkImageAspectFlags aspect_mask, VkImageAspectFlags aspect) {
611 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700612 return;
613 }
614 VkImageSubresource sub = {aspect, level, layer};
615 IMAGE_CMD_BUF_LAYOUT_NODE node;
616 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700617 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700618 SetLayout(device_data, pCB, mem_barrier->image, sub,
619 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
620 return;
621 }
622 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
623 // TODO: Set memory invalid
624 }
625 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
626}
627
Dave Houlton10b39482017-03-16 13:18:15 -0600628bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600629 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600630 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600631 }
632 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600633 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600634 }
635 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600636 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600637 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700638 if (0 !=
639 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
640 if (FormatPlaneCount(format) == 1) return false;
641 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600642 return true;
643}
644
Mike Weiblen62d08a32017-03-07 22:18:27 -0700645// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
646bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
647 VkImageUsageFlags usage_flags, const char *func_name) {
648 const auto report_data = core_validation::GetReportData(device_data);
649 bool skip = false;
650 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Dave Houlton8e9f6542018-05-18 12:18:22 -0600651 std::string msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700652
653 switch (layout) {
654 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
655 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600656 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700657 }
658 break;
659 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
660 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600661 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700662 }
663 break;
664 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
665 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600666 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700667 }
668 break;
669 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
670 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600671 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700672 }
673 break;
674 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
675 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600676 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677 }
678 break;
679 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
680 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600681 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700682 }
683 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600684 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500685 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
686 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
687 }
688 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700689 default:
690 // Other VkImageLayout values do not have VUs defined in this context.
691 break;
692 }
693
Dave Houlton8e9f6542018-05-18 12:18:22 -0600694 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600695 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 -0600696 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600697 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
698 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
699 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700700 }
701 return skip;
702}
703
John Zulauf463c51e2018-05-31 13:29:20 -0600704// Scoreboard for checking for duplicate and inconsistent barriers to images
705struct ImageBarrierScoreboardEntry {
706 uint32_t index;
707 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
708 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
709 const VkImageMemoryBarrier *barrier;
710};
711using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
712using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
713
Mike Weiblen62d08a32017-03-07 22:18:27 -0700714// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600715bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700716 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700717 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700718
John Zulauf463c51e2018-05-31 13:29:20 -0600719 // Scoreboard for duplicate layout transition barriers within the list
720 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
721 ImageBarrierScoreboardImageMap layout_transitions;
722
Mike Weiblen62d08a32017-03-07 22:18:27 -0700723 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
724 auto img_barrier = &pImageMemoryBarriers[i];
725 if (!img_barrier) continue;
726
John Zulauf463c51e2018-05-31 13:29:20 -0600727 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
728 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
729 // at a per sub-resource level
730 if (img_barrier->oldLayout != img_barrier->newLayout) {
731 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
732 auto image_it = layout_transitions.find(img_barrier->image);
733 if (image_it != layout_transitions.end()) {
734 auto &subres_map = image_it->second;
735 auto subres_it = subres_map.find(img_barrier->subresourceRange);
736 if (subres_it != subres_map.end()) {
737 auto &entry = subres_it->second;
738 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
739 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
740 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
741 skip = log_msg(
742 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
743 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_state->commandBuffer),
744 "VUID-VkImageMemoryBarrier-oldLayout-01197",
745 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image 0x%" PRIx64
746 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
747 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
748 func_name, i, entry.index, HandleToUint64(img_barrier->image), range.aspectMask, range.baseMipLevel,
749 range.levelCount, range.baseArrayLayer, range.layerCount, string_VkImageLayout(img_barrier->oldLayout),
750 string_VkImageLayout(entry.barrier->newLayout));
751 }
752 entry = new_entry;
753 } else {
754 subres_map[img_barrier->subresourceRange] = new_entry;
755 }
756 } else {
757 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
758 }
759 }
760
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600761 auto image_state = GetImageState(device_data, img_barrier->image);
762 if (image_state) {
763 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
764 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
765 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
766
767 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
768 if (image_state->layout_locked) {
769 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600770 skip |= log_msg(
771 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Young9d1ac312018-05-21 16:28:27 -0600772 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100773 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600774 " 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 +0100775 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600776 string_VkImageLayout(img_barrier->newLayout));
777 }
778 }
779
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600780 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600781 // For a Depth/Stencil image both aspects MUST be set
782 if (FormatIsDepthAndStencil(image_create_info->format)) {
783 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
784 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
785 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600786 skip |=
787 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -0600788 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image),
789 "VUID-VkImageMemoryBarrier-image-01207",
Mark Lobodzinski88529492018-04-01 10:38:15 -0600790 "%s: Image barrier 0x%p references image 0x%" PRIx64
791 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
792 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
793 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600794 }
795 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600796 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
797 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700798
Mike Weiblen62d08a32017-03-07 22:18:27 -0700799 for (uint32_t j = 0; j < level_count; j++) {
800 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
801 for (uint32_t k = 0; k < layer_count; k++) {
802 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600803 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
804 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
805 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
806 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700807 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
808 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
809 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
810 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
811 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
812 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
813 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
814 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700815 }
816 }
817 }
818 return skip;
819}
820
Chris Forbes4de4b132017-08-21 11:27:08 -0700821static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600822 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700823
824 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600825 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700826}
827
John Zulauf6b4aae82018-05-09 13:03:36 -0600828template <typename Barrier>
829bool ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
830 uint32_t barrier_count, const Barrier *barriers) {
831 using BarrierRecord = QFOTransferBarrier<Barrier>;
832 bool skip = false;
833 const auto report_data = core_validation::GetReportData(device_data);
834 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
835 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
836 const char *barrier_name = BarrierRecord::BarrierName();
837 const char *handle_name = BarrierRecord::HandleName();
838 const char *transfer_type = nullptr;
839 for (uint32_t b = 0; b < barrier_count; b++) {
840 if (!IsTransferOp(&barriers[b])) continue;
841 const BarrierRecord *barrier_record = nullptr;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600842 if (IsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600843 const auto found = barrier_sets.release.find(barriers[b]);
844 if (found != barrier_sets.release.cend()) {
845 barrier_record = &(*found);
846 transfer_type = "releasing";
847 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600848 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
849 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600850 const auto found = barrier_sets.acquire.find(barriers[b]);
851 if (found != barrier_sets.acquire.cend()) {
852 barrier_record = &(*found);
853 transfer_type = "acquiring";
854 }
855 }
856 if (barrier_record != nullptr) {
857 skip |=
858 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
859 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
860 "%s: %s at index %" PRIu32 " %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
861 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
862 func_name, barrier_name, b, transfer_type, handle_name, HandleToUint64(barrier_record->handle),
863 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
864 }
865 }
866 return skip;
867}
868
869template <typename Barrier>
870void RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
871 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
872 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
873 for (uint32_t b = 0; b < barrier_count; b++) {
874 if (!IsTransferOp(&barriers[b])) continue;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600875 if (IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600876 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600877 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
878 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600879 barrier_sets.acquire.emplace(barriers[b]);
880 }
881 }
882}
883
884bool ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
885 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
886 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
887 bool skip = false;
888 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
889 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
890 return skip;
891}
892
893void RecordBarriersQFOTransfers(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
894 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
895 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
896 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
897 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
898}
899
900template <typename BarrierRecord, typename Scoreboard>
901static bool ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
902 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
903 // Record to the scoreboard or report that we have a duplication
904 bool skip = false;
905 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
906 if (!inserted.second && inserted.first->second != cb_state) {
907 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
908 skip = log_msg(
909 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
910 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
911 "%s: %s %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
912 " duplicates existing barrier submitted in this batch from command buffer 0x%" PRIx64 ".",
913 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(), HandleToUint64(barrier.handle),
914 barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex, HandleToUint64(inserted.first->second));
915 }
916 return skip;
917}
918
919template <typename Barrier>
920static bool ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
921 QFOTransferCBScoreboards<Barrier> *scoreboards) {
922 using BarrierRecord = QFOTransferBarrier<Barrier>;
923 using TypeTag = typename BarrierRecord::Tag;
924 bool skip = false;
925 const auto report_data = core_validation::GetReportData(device_data);
926 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
927 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
928 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
929 const char *barrier_name = BarrierRecord::BarrierName();
930 const char *handle_name = BarrierRecord::HandleName();
931 // No release should have an extant duplicate (WARNING)
932 for (const auto &release : cb_barriers.release) {
933 // Check the global pending release barriers
934 const auto set_it = global_release_barriers.find(release.handle);
935 if (set_it != global_release_barriers.cend()) {
936 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
937 const auto found = set_for_handle.find(release);
938 if (found != set_for_handle.cend()) {
939 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
940 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
941 "%s: %s releasing queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
942 " to dstQueueFamilyIndex %" PRIu32
943 " duplicates existing barrier queued for execution, without intervening acquire operation.",
944 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(found->handle),
945 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
946 }
947 }
948 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
949 }
950 // Each acquire must have a matching release (ERROR)
951 for (const auto &acquire : cb_barriers.acquire) {
952 const auto set_it = global_release_barriers.find(acquire.handle);
953 bool matching_release_found = false;
954 if (set_it != global_release_barriers.cend()) {
955 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
956 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
957 }
958 if (!matching_release_found) {
959 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
960 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
961 "%s: in submitted command buffer %s aquiring ownership of %s (0x%" PRIx64
962 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
963 " has no matching release barrier queued for execution.",
964 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(acquire.handle),
965 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
966 }
967 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
968 }
969 return skip;
970}
971
972bool ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
973 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
974 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
975 bool skip = false;
976 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
977 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
978 return skip;
979}
980
981template <typename Barrier>
982static void RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
983 using BarrierRecord = QFOTransferBarrier<Barrier>;
984 using TypeTag = typename BarrierRecord::Tag;
985 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
986 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
987 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
988
989 // Add release barriers from this submit to the global map
990 for (const auto &release : cb_barriers.release) {
991 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
992 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
993 global_release_barriers[release.handle].insert(release);
994 }
995
996 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
997 for (const auto &acquire : cb_barriers.acquire) {
998 // NOTE: We're not using [] because we don't want to create entries for missing releases
999 auto set_it = global_release_barriers.find(acquire.handle);
1000 if (set_it != global_release_barriers.end()) {
1001 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1002 set_for_handle.erase(acquire);
1003 if (set_for_handle.size() == 0) { // Clean up empty sets
1004 global_release_barriers.erase(set_it);
1005 }
1006 }
1007 }
1008}
1009
1010void RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1011 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1012 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1013}
1014
1015// Remove the pending QFO release records from the global set
1016// Note that the type of the handle argument constrained to match Barrier type
1017// The defaulted BarrierRecord argument allows use to declare the type once, but is not intended to be specified by the caller
1018template <typename Barrier, typename BarrierRecord = QFOTransferBarrier<Barrier>>
1019static void EraseQFOReleaseBarriers(layer_data *device_data, const typename BarrierRecord::HandleType &handle) {
1020 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1021 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, typename BarrierRecord::Tag());
1022 global_release_barriers.erase(handle);
1023}
1024
1025// Avoid making the template globally visible by exporting the one instance of it we need.
1026void EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
1027 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1028}
1029
Chris Forbes399a6782017-08-18 15:00:48 -07001030void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001031 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001032 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1033 auto mem_barrier = &pImgMemBarriers[i];
1034 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001035
Chris Forbes4de4b132017-08-21 11:27:08 -07001036 // For ownership transfers, the barrier is specified twice; as a release
1037 // operation on the yielding queue family, and as an acquire operation
1038 // on the acquiring queue family. This barrier may also include a layout
1039 // transition, which occurs 'between' the two operations. For validation
1040 // purposes it doesn't seem important which side performs the layout
1041 // transition, but it must not be performed twice. We'll arbitrarily
1042 // choose to perform it as part of the acquire operation.
1043 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
1044 continue;
1045 }
1046
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001047 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
1048 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1049 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1050
Dave Houltonb3f4b282018-02-22 16:25:16 -07001051 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1052 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1053 // for all (potential) layer sub_resources.
1054 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1055 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1056 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1057 }
1058
Tony-LunarG0d27b302018-10-08 09:26:21 -06001059 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1060 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
1061 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1062 if (FormatIsMultiplane(image_create_info->format)) {
1063 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1064 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1065 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1066 if (FormatPlaneCount(image_create_info->format) > 2) {
1067 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1068 }
1069 }
1070 }
1071 }
1072
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001073 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001074 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001075 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001076 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Tony-LunarG0d27b302018-10-08 09:26:21 -06001077 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1078 VK_IMAGE_ASPECT_COLOR_BIT);
1079 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1080 VK_IMAGE_ASPECT_DEPTH_BIT);
1081 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1082 VK_IMAGE_ASPECT_STENCIL_BIT);
1083 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1084 VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001085 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001086 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1087 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1088 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1089 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1090 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1091 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001092 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001093 }
1094 }
1095 }
1096}
1097
Tobin Ehlisc8266452017-04-07 12:20:30 -06001098bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001099 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07001100 const char *caller, const std::string &layout_invalid_msg_code, const std::string &layout_mismatch_msg_code,
1101 bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001102 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001103 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001104 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001105
1106 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1107 uint32_t layer = i + subLayers.baseArrayLayer;
1108 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1109 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001110 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1111 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001112 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001113 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1114 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1115 "%s: Cannot use image 0x%" PRIx64
1116 " (layer=%u mip=%u) with specific layout %s that doesn't match the actual current layout %s.",
1117 caller, HandleToUint64(image), layer, subLayers.mipLevel, string_VkImageLayout(explicit_layout),
1118 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001119 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001120 }
1121 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001122 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1123 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1124 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001125 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1126 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001127 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001128 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001129 kVUID_Core_DrawState_InvalidImageLayout,
Petr Kraus13c98a62017-12-09 00:22:39 +01001130 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
1131 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001132 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001133 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001134 if (image_state->shared_presentable) {
1135 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001136 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1137 layout_invalid_msg_code,
1138 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1139 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001140 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001141 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001142 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001143 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001144 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 -07001145 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001146 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1147 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001148 }
1149 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001150 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001151}
1152
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001153void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
1154 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001155 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001156 if (!renderPass) return;
1157
Tobias Hectorbbb12282018-10-22 15:17:59 +01001158 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001159 if (framebuffer_state) {
1160 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -06001161 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
1162 if (view_state) {
1163 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
1164 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001165 }
1166 }
1167}
Dave Houltone19e20d2018-02-02 16:32:41 -07001168
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001169bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001170 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001171 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001172 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1173
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001174 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001175 skip |=
1176 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1177 "VUID-VkImageCreateInfo-format-00943", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001178
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001179 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001180 }
1181
Dave Houlton130c0212018-01-29 13:39:56 -07001182 const char *format_string = string_VkFormat(pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -07001183
1184 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
1185 std::stringstream ss;
1186 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 -06001187 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 -06001188 "VUID-VkImageCreateInfo-flags-00949", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001189 }
1190
1191 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
1192 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
Shannon McPhersona886c2a2018-10-12 14:38:20 -06001193 GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001194
Dave Houlton130c0212018-01-29 13:39:56 -07001195 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1196 std::stringstream ss;
1197 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001198 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06001199 "VUID-VkImageCreateInfo-mipLevels-02255", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001200 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001201
Dave Houlton130c0212018-01-29 13:39:56 -07001202 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1203 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1204 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
1205 std::stringstream ss;
1206 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
1207 "maxFramebufferWidth";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001208 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 -06001209 "VUID-VkImageCreateInfo-usage-00964", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001210 }
1211
1212 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
1213 std::stringstream ss;
1214 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
1215 "maxFramebufferHeight";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001216 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 -06001217 "VUID-VkImageCreateInfo-usage-00965", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001218 }
1219
1220 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1221 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1222 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
1223
1224 // Round up to imageGranularity boundary
1225 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
1226 uint64_t ig_mask = imageGranularity - 1;
1227 total_size = (total_size + ig_mask) & ~ig_mask;
1228
1229 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001230 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 -06001231 kVUID_Core_Image_InvalidFormatLimitsViolation,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001232 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1233 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -07001234 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001235 }
1236
Dave Houlton130c0212018-01-29 13:39:56 -07001237 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001238 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06001239 "VUID-VkImageCreateInfo-arrayLayers-02256",
Dave Houltond8ed0212018-05-16 17:18:24 -06001240 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d.", pCreateInfo->arrayLayers,
1241 format_limits.maxArrayLayers);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001242 }
1243
Dave Houlton130c0212018-01-29 13:39:56 -07001244 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001245 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06001246 "VUID-VkImageCreateInfo-samples-02258", "CreateImage samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001247 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001248 }
1249
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06001250 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) &&
1251 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001252 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 -06001253 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001254 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1255 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001256 }
1257
Lenny Komowb79f04a2017-09-18 17:07:00 -06001258 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1259 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1260 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1261 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1262 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001263 skip |=
1264 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1265 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1266 "format must be block, ETC or ASTC compressed, but is %s",
1267 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001268 }
1269 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1270 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001271 skip |=
1272 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1273 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1274 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001275 }
1276 }
1277 }
1278
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001279 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001280}
1281
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001282void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001283 IMAGE_LAYOUT_NODE image_state;
1284 image_state.layout = pCreateInfo->initialLayout;
1285 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001286 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 -07001287 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001288 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1289 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001290}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001291
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001292bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001293 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001294 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +02001295 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001296 if (disabled->destroy_image) return false;
1297 bool skip = false;
1298 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06001299 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001300 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001301 }
1302 return skip;
1303}
1304
John Zulauffca05c12018-04-26 16:30:39 -06001305void PreCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001306 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001307 // Clean up memory mapping, bindings and range references for image
1308 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001309 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001310 if (mem_info) {
1311 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1312 }
1313 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001314 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001315 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001316 // Remove image from imageMap
1317 core_validation::GetImageMap(device_data)->erase(image);
1318 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1319 core_validation::GetImageSubresourceMap(device_data);
1320
1321 const auto &sub_entry = imageSubresourceMap->find(image);
1322 if (sub_entry != imageSubresourceMap->end()) {
1323 for (const auto &pair : sub_entry->second) {
1324 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1325 }
1326 imageSubresourceMap->erase(sub_entry);
1327 }
1328}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001329
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001330bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001331 bool skip = false;
1332 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1333
1334 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1335 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1336 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 -06001337 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001338 }
1339
Dave Houlton1d2022c2017-03-29 11:43:58 -06001340 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001341 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1342 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 -06001343 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001344 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001345 char const str[] = "vkCmdClearColorImage called with compressed image.";
1346 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 -06001347 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001348 }
1349
1350 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1351 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1352 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 -06001353 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001354 }
1355 return skip;
1356}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001357
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001358uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1359 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1360 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001361 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001362 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001363 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001364 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001365}
1366
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001367uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1368 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1369 uint32_t array_layer_count = range->layerCount;
1370 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1371 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001372 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001373 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001374}
1375
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001376bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001377 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1378 bool skip = false;
1379 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1380
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001381 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1382 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001383
1384 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1385 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001386 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1387 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001388 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 -06001389 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001390 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1391 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001392 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001393 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001394 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001395 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 -06001396 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001397 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1398 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001399
1400 } else {
1401 if (image_state->shared_presentable) {
1402 skip |= log_msg(
1403 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001404 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001405 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1406 string_VkImageLayout(dest_image_layout));
1407 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001408 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001409 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001410 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001411 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001412 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001413 } else {
1414 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1415 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001416 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 -06001417 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001418 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1419 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001420 }
1421 }
1422
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001423 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1424 uint32_t level = level_index + range.baseMipLevel;
1425 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1426 uint32_t layer = layer_index + range.baseArrayLayer;
1427 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001428 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001429 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001430 if (node.layout != dest_image_layout) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001431 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001432 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001433 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001434 } else {
1435 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1436 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001437 skip |=
1438 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1439 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1440 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001441 }
1442 }
1443 }
1444 }
1445
1446 return skip;
1447}
1448
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001449void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1450 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001451 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1452 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1453 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001454
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001455 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1456 uint32_t level = level_index + range.baseMipLevel;
1457 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1458 uint32_t layer = layer_index + range.baseArrayLayer;
1459 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001460 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001461 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1462 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 -07001463 }
1464 }
1465 }
1466}
1467
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001468bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001469 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1470 bool skip = false;
1471 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001472 auto cb_node = GetCBNode(dev_data, commandBuffer);
1473 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001474 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001475 skip |=
1476 ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001477 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001478 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001479 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001480 if (GetApiVersion(dev_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001481 skip |=
1482 ValidateImageFormatFeatureFlags(dev_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001483 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001484 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001485 skip |= InsideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001486 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001487 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001488 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001489 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001490 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001491 }
1492 }
1493 return skip;
1494}
1495
1496// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001497void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001498 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001499 auto cb_node = GetCBNode(dev_data, commandBuffer);
1500 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001501 if (cb_node && image_state) {
1502 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001503 for (uint32_t i = 0; i < rangeCount; ++i) {
1504 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1505 }
1506 }
1507}
1508
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001509bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1510 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001511 const VkImageSubresourceRange *pRanges) {
1512 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001513 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1514
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001515 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001516 auto cb_node = GetCBNode(device_data, commandBuffer);
1517 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001518 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001519 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1520 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001521 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001522 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001523 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001524 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1525 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001526 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1527 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001528 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001529 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001530 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001531 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001532 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001533 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001534 skip |=
1535 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001536 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001537 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1538 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001539 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001540 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1541 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001542 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 -06001543 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001544 }
1545 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001546 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001547 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001548 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 -06001549 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001550 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001551 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1552 char const str[] =
1553 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1554 "set.";
1555 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001556 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001557 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001558 }
1559 return skip;
1560}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001561
1562// Returns true if [x, xoffset] and [y, yoffset] overlap
1563static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1564 bool result = false;
1565 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1566 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1567
1568 if (intersection_max > intersection_min) {
1569 result = true;
1570 }
1571 return result;
1572}
1573
Dave Houltonc991cc92018-03-06 11:08:51 -07001574// Returns true if source area of first copy region intersects dest area of second region
1575// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1576static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001577 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001578
Dave Houltonc991cc92018-03-06 11:08:51 -07001579 // Separate planes within a multiplane image cannot intersect
1580 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001581 return result;
1582 }
1583
Dave Houltonc991cc92018-03-06 11:08:51 -07001584 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1585 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1586 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001587 result = true;
1588 switch (type) {
1589 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001590 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001591 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001592 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001593 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001594 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001595 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001596 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001597 break;
1598 default:
1599 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1600 assert(false);
1601 }
1602 }
1603 return result;
1604}
1605
Dave Houltonfc1a4052017-04-27 14:32:45 -06001606// Returns non-zero if offset and extent exceed image extents
1607static const uint32_t x_bit = 1;
1608static const uint32_t y_bit = 2;
1609static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001610static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001611 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001612 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001613 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1614 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001615 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001616 }
1617 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1618 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001619 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001620 }
1621 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1622 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001623 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001624 }
1625 return result;
1626}
1627
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001628// Test if two VkExtent3D structs are equivalent
1629static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1630 bool result = true;
1631 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1632 (extent->depth != other_extent->depth)) {
1633 result = false;
1634 }
1635 return result;
1636}
1637
Dave Houltonee281a52017-12-08 13:51:02 -07001638// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1639// Destination image texel extents must be adjusted by block size for the dest validation checks
1640VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1641 VkExtent3D adjusted_extent = extent;
1642 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1643 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1644 adjusted_extent.width /= block_size.width;
1645 adjusted_extent.height /= block_size.height;
1646 adjusted_extent.depth /= block_size.depth;
1647 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1648 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1649 adjusted_extent.width *= block_size.width;
1650 adjusted_extent.height *= block_size.height;
1651 adjusted_extent.depth *= block_size.depth;
1652 }
1653 return adjusted_extent;
1654}
1655
Dave Houlton6f9059e2017-05-02 17:15:13 -06001656// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001657static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1658 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001659
1660 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001661 if (mip >= img->createInfo.mipLevels) {
1662 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001663 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001664
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001665 // 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 -06001666 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001667
1668 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1669 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001670 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001671 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1672 } else {
1673 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1674 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1675 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1676 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001677
Dave Houlton6f9059e2017-05-02 17:15:13 -06001678 // Image arrays have an effective z extent that isn't diminished by mip level
1679 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001680 extent.depth = img->createInfo.arrayLayers;
1681 }
1682
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001683 return extent;
1684}
1685
1686// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001687static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001688 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1689}
1690
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001691// Test if the extent argument has any dimensions set to 0.
1692static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1693 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1694}
1695
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001696// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1697static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1698 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1699 VkExtent3D granularity = {0, 0, 0};
1700 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1701 if (pPool) {
1702 granularity =
1703 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001704 if (FormatIsCompressed(img->createInfo.format)) {
1705 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001706 granularity.width *= block_size.width;
1707 granularity.height *= block_size.height;
1708 }
1709 }
1710 return granularity;
1711}
1712
1713// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1714static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1715 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001716 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1717 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001718 valid = false;
1719 }
1720 return valid;
1721}
1722
1723// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1724static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001725 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001726 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001727 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1728 bool skip = false;
1729 VkExtent3D offset_extent = {};
1730 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1731 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1732 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001733 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001734 // 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 -07001735 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001736 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 -04001737 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001738 "%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 "
1739 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001740 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001741 }
1742 } else {
1743 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1744 // integer multiples of the image transfer granularity.
1745 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001746 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 -04001747 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001748 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1749 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001750 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1751 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001752 }
1753 }
1754 return skip;
1755}
1756
1757// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1758static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1759 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001760 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001761 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001762 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1763 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001764 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001765 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1766 // subresource extent.
1767 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001768 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 -04001769 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001770 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1771 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1772 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1773 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001774 }
1775 } else {
1776 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1777 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1778 // subresource extent dimensions.
1779 VkExtent3D offset_extent_sum = {};
1780 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1781 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1782 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001783 bool x_ok = true;
1784 bool y_ok = true;
1785 bool z_ok = true;
1786 switch (image_type) {
1787 case VK_IMAGE_TYPE_3D:
1788 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1789 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001790 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001791 case VK_IMAGE_TYPE_2D:
1792 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1793 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001794 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001795 case VK_IMAGE_TYPE_1D:
1796 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1797 (subresource_extent->width == offset_extent_sum.width));
1798 break;
1799 default:
1800 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1801 assert(false);
1802 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001803 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001804 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 -04001805 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001806 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1807 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1808 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1809 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1810 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1811 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001812 }
1813 }
1814 return skip;
1815}
1816
Cort Strattonff1542a2018-05-27 10:49:28 -07001817bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
1818 const uint32_t i, const char *function, const char *member, const std::string &vuid) {
1819 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1820 bool skip = false;
1821 if (mip_level >= img->createInfo.mipLevels) {
1822 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1823 HandleToUint64(cb_node->commandBuffer), vuid,
1824 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
1825 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
1826 }
1827 return skip;
1828}
1829
1830bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
1831 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
1832 const char *member, const std::string &vuid) {
1833 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1834 bool skip = false;
1835 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
1836 (base_layer + layer_count) > img->createInfo.arrayLayers) {
1837 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1838 HandleToUint64(cb_node->commandBuffer), vuid,
1839 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
1840 "%u, but provided image %" PRIx64 " has %u array layers.",
1841 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
1842 }
1843 return skip;
1844}
1845
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001846// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001847bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1848 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Dave Houltone0969282018-05-23 15:54:31 -06001849 const uint32_t i, const char *function, const std::string &vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001850 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04001851 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1852 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
1853 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1854 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1855 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001856 return skip;
1857}
1858
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001859// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001860bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001861 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1862 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001863 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001864 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001865 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06001866 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
1867 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001868 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001869 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001870 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06001871 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001872
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001873 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001874 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06001875 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
1876 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07001877 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001878 const VkExtent3D dest_effective_extent =
1879 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001880 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001881 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06001882 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001883 return skip;
1884}
1885
Dave Houlton6f9059e2017-05-02 17:15:13 -06001886// Validate contents of a VkImageCopy struct
1887bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1888 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1889 bool skip = false;
1890
1891 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001892 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001893
1894 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001895 const VkExtent3D src_copy_extent = region.extent;
1896 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001897 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1898
Dave Houlton6f9059e2017-05-02 17:15:13 -06001899 bool slice_override = false;
1900 uint32_t depth_slices = 0;
1901
1902 // Special case for copying between a 1D/2D array and a 3D image
1903 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1904 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001905 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001906 slice_override = (depth_slices != 1);
1907 } 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 -07001908 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001909 slice_override = (depth_slices != 1);
1910 }
1911
1912 // Do all checks on source image
1913 //
1914 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001915 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1916 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 -06001917 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07001918 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001919 "be 0 and 1, respectively.",
1920 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001921 }
1922 }
1923
Dave Houlton533be9f2018-03-26 17:08:30 -06001924 // VUID-VkImageCopy-srcImage-01785
1925 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1926 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 -06001927 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06001928 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001929 "these must be 0 and 1, respectively.",
1930 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001931 }
1932
Dave Houlton533be9f2018-03-26 17:08:30 -06001933 // VUID-VkImageCopy-srcImage-01787
1934 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1935 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 -06001936 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001937 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
1938 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06001939 }
1940
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001941 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001942 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001943 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001944 skip |=
1945 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001946 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001947 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001948 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1949 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001950 }
1951 }
1952 } else { // Pre maint 1
1953 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001954 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001955 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 -06001956 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01001957 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1958 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001959 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1960 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001961 }
1962 }
1963 }
1964
Dave Houltonc991cc92018-03-06 11:08:51 -07001965 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1966 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
1967 if (FormatIsCompressed(src_state->createInfo.format) ||
1968 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001969 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001970 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001971 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1972 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1973 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001974 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001975 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 -07001976 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001977 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001978 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001979 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001980 }
1981
Dave Houlton94a00372017-12-14 15:08:47 -07001982 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001983 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1984 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001985 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001986 skip |=
1987 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001988 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001989 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001990 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001991 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001992 }
1993
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001994 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001995 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1996 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001997 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001998 skip |=
1999 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002000 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002001 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002002 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002003 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002004 }
2005
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002006 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002007 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2008 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002009 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002010 skip |=
2011 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002012 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002013 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002014 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002015 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002016 }
2017 } // Compressed
2018
2019 // Do all checks on dest image
2020 //
2021 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002022 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002023 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 -06002024 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002025 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002026 "these must be 0 and 1, respectively.",
2027 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002028 }
2029 }
2030
Dave Houlton533be9f2018-03-26 17:08:30 -06002031 // VUID-VkImageCopy-dstImage-01786
2032 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2033 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 -06002034 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002035 "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 -06002036 "and 1, respectively.",
2037 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002038 }
2039
2040 // VUID-VkImageCopy-dstImage-01788
2041 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2042 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 -06002043 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002044 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2045 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002046 }
2047
2048 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002049 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002050 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 -06002051 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002052 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002053 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2054 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002055 }
2056 }
2057 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002058 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002059 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002060 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002061 skip |=
2062 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002063 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002064 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002065 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2066 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002067 }
2068 }
2069 } else { // Pre maint 1
2070 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002071 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002072 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 -06002073 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002074 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2075 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002076 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2077 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002078 }
2079 }
2080 }
2081
Dave Houltonc991cc92018-03-06 11:08:51 -07002082 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2083 if (FormatIsCompressed(dst_state->createInfo.format) ||
2084 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002085 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002086
2087 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002088 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2089 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2090 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002091 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002092 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 -07002093 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002094 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002095 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002096 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002097 }
2098
Dave Houlton94a00372017-12-14 15:08:47 -07002099 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002100 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2101 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002102 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002103 skip |=
2104 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002105 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002106 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002107 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002108 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002109 }
2110
Dave Houltonee281a52017-12-08 13:51:02 -07002111 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2112 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2113 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002114 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002115 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 -07002116 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002117 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2118 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002119 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002120 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002121 }
2122
Dave Houltonee281a52017-12-08 13:51:02 -07002123 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2124 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2125 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002126 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002127 skip |=
2128 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002129 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002130 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002131 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002132 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002133 }
2134 } // Compressed
2135 }
2136 return skip;
2137}
2138
Dave Houltonc991cc92018-03-06 11:08:51 -07002139// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2140bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2141 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2142 bool skip = false;
2143 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2144
2145 // Neither image is multiplane
2146 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2147 // If neither image is multi-plane the aspectMask member of src and dst must match
2148 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2149 std::stringstream ss;
2150 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
2151 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2152 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 -06002153 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002154 }
2155 } else {
2156 // Source image multiplane checks
2157 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2158 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2159 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2160 std::stringstream ss;
2161 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2162 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 -06002163 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002164 }
2165 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2166 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2167 std::stringstream ss;
2168 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2169 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 -06002170 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002171 }
2172 // Single-plane to multi-plane
2173 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2174 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2175 std::stringstream ss;
2176 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2177 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 -06002178 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002179 }
2180
2181 // Dest image multiplane checks
2182 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2183 aspect = region.dstSubresource.aspectMask;
2184 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2185 std::stringstream ss;
2186 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2187 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 -06002188 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002189 }
2190 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2191 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2192 std::stringstream ss;
2193 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2194 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 -06002195 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002196 }
2197 // Multi-plane to single-plane
2198 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2199 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2200 std::stringstream ss;
2201 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2202 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-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002204 }
2205 }
2206
2207 return skip;
2208}
2209
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002210bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002211 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2212 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002213 bool skip = false;
2214 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002215 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
2216
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002217 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2218
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002219 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002220 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002221
2222 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2223 VkExtent3D src_copy_extent = region.extent;
2224 VkExtent3D dst_copy_extent =
2225 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2226
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227 bool slice_override = false;
2228 uint32_t depth_slices = 0;
2229
2230 // Special case for copying between a 1D/2D array and a 3D image
2231 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2232 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2233 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002234 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002235 slice_override = (depth_slices != 1);
2236 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2237 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002238 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002239 slice_override = (depth_slices != 1);
2240 }
2241
Cort Strattond619a302018-05-17 19:46:32 -07002242 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2243 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002244 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2245 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2246 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2247 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2248 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2249 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2250 "VUID-vkCmdCopyImage-srcSubresource-01698");
2251 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2252 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2253 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002254
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002255 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002256 // No chance of mismatch if we're overriding depth slice count
2257 if (!slice_override) {
2258 // The number of depth slices in srcSubresource and dstSubresource must match
2259 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2260 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002261 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2262 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002263 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002264 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2265 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002266 if (src_slices != dst_slices) {
2267 std::stringstream ss;
2268 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
2269 << "] do not match";
2270 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 -06002271 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002272 }
2273 }
2274 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002275 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002276 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002277 std::stringstream ss;
2278 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
2279 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002280 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 -06002281 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002282 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002283 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002284
Dave Houltonc991cc92018-03-06 11:08:51 -07002285 // Do multiplane-specific checks, if extension enabled
2286 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2287 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2288 }
2289
Dave Houltonf5217612018-02-02 16:18:52 -07002290 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2291 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2292 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2293 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
2294 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 -06002295 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002296 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002297 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002298
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002299 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002300 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002301 std::stringstream ss;
2302 ss << "vkCmdCopyImage: pRegion[" << i
2303 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2304 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 -06002305 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002306 }
2307
2308 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002309 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002310 std::stringstream ss;
2311 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2312 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 -06002313 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002314 }
2315
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002316 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2317 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2318 // 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 -07002319 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2320 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002321 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002322 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
2323 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2324 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2325 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002326 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 -06002327 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002328 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002329
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002330 // 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 -07002331 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2332 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002333 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002334 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2335 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2336 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2337 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002338 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 -06002339 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002340 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002341 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002342
Dave Houltonfc1a4052017-04-27 14:32:45 -06002343 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002344 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2345 if (slice_override) src_copy_extent.depth = depth_slices;
2346 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002347 if (extent_check & x_bit) {
2348 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 -06002349 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002350 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002351 "width [%1d].",
2352 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002353 }
2354
2355 if (extent_check & y_bit) {
2356 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 -06002357 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002358 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002359 "height [%1d].",
2360 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002361 }
2362 if (extent_check & z_bit) {
2363 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002364 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002365 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002366 "depth [%1d].",
2367 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002368 }
2369
Dave Houltonee281a52017-12-08 13:51:02 -07002370 // Adjust dest extent if necessary
2371 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2372 if (slice_override) dst_copy_extent.depth = depth_slices;
2373
2374 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002375 if (extent_check & x_bit) {
2376 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 -06002377 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002378 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002379 "width [%1d].",
2380 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002381 }
2382 if (extent_check & y_bit) {
2383 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 -06002384 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002385 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002386 "height [%1d].",
2387 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002388 }
2389 if (extent_check & z_bit) {
2390 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002391 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002392 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002393 "depth [%1d].",
2394 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002395 }
2396
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002397 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2398 // must not overlap in memory
2399 if (src_image_state->image == dst_image_state->image) {
2400 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002401 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2402 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002403 std::stringstream ss;
2404 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2405 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002406 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002407 }
2408 }
2409 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002410 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002411
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002412 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2413 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2414 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002415 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002416 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2417 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002418 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 -06002419 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002420 }
2421 } else {
Tony-LunarG7482ca92018-10-01 14:20:22 -06002422 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, region_count, regions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002423 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2424 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 -06002425 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002426 }
2427 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002428
Dave Houlton33c22b72017-02-28 13:16:02 -07002429 // Source and dest image sample counts must match
2430 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2431 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2432 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 -06002433 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002434 }
2435
Dave Houltond8ed0212018-05-16 17:18:24 -06002436 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2437 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002438 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002439 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2440 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2441 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2442 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002443 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002444 skip |=
2445 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002446 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002447 skip |=
2448 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002449 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002450 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002451 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002452 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2453 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002454 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002455 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002456 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07002457 const std::string invalid_src_layout_vuid =
2458 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2459 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2460 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2461 const std::string invalid_dst_layout_vuid =
2462 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2463 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2464 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002465 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002466 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002467 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2468 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002469 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002470 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2471 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002472 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2473 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002474 }
2475
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002476 return skip;
2477}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002478
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002479void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002480 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2481 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2482 // Make sure that all image slices are updated to correct layout
2483 for (uint32_t i = 0; i < region_count; ++i) {
2484 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2485 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2486 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002487 // Update bindings between images and cmd buffer
2488 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2489 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002490}
2491
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002492// Returns true if sub_rect is entirely contained within rect
2493static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2494 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2495 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2496 return false;
2497 return true;
2498}
2499
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002500bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2501 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002502 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002503 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2504
2505 bool skip = false;
2506 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002507 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002508 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002509 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002510 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002511 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002512 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2513 // 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 -07002514 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2515 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002516 skip |= log_msg(
2517 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002518 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002519 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2520 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2521 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002522 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002523 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002524 }
2525
2526 // Validate that attachment is in reference list of active subpass
2527 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002528 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2529 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002530 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002531
2532 for (uint32_t i = 0; i < attachmentCount; i++) {
2533 auto clear_desc = &pAttachments[i];
2534 VkImageView image_view = VK_NULL_HANDLE;
2535
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002536 if (0 == clear_desc->aspectMask) {
2537 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 -06002538 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002539 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2540 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 -06002541 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002542 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002543 if ((subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment != VK_ATTACHMENT_UNUSED) &&
2544 (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002545 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002546 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2547 "vkCmdClearAttachments() color attachment index %d is not VK_ATTACHMENT_UNUSED and is out of "
2548 "range for active subpass %d.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002549 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002550 } else {
2551 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002552 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002553 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002554 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2555 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2556 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002557 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002558 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(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002560 }
2561 } else { // Must be depth and/or stencil
2562 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2563 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002564 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002565 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 -06002566 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002567 }
2568 if (!subpass_desc->pDepthStencilAttachment ||
2569 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2570 skip |= log_msg(
2571 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002572 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002573 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002574 } else {
2575 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2576 }
2577 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002578 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002579 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002580 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002581 // The rectangular region specified by a given element of pRects must be contained within the render area of
2582 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002583 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2584 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2585 skip |=
2586 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002587 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002588 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002589 "the current render pass instance.",
2590 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002591 }
2592 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002593 const auto local_rect =
2594 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002595 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002596 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002597 return log_msg(
2598 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002599 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002600 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002601 "the current render pass instance.",
2602 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002603 }
2604 return false;
2605 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002606 }
2607 // The layers specified by a given element of pRects must be contained within every attachment that
2608 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002609 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002610 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2611 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002612 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002613 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00017",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002614 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002615 "of pAttachment[%d].",
2616 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002617 }
2618 }
2619 }
2620 }
2621 }
2622 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002623}
2624
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002625bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Cort Stratton7df30962018-05-17 19:45:57 -07002626 VkImageLayout src_image_layout, IMAGE_STATE *dst_image_state, VkImageLayout dst_image_layout,
2627 uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002628 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002629 bool skip = false;
2630 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002631 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2632 "VUID-vkCmdResolveImage-srcImage-00256");
2633 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2634 "VUID-vkCmdResolveImage-dstImage-00258");
2635 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2636 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002637 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002638 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002639 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002640 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2641 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002642
Cort Stratton7df30962018-05-17 19:45:57 -07002643 bool hit_error = false;
2644 const std::string invalid_src_layout_vuid =
2645 (src_image_state->shared_presentable &&
2646 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2647 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2648 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2649 const std::string invalid_dst_layout_vuid =
2650 (dst_image_state->shared_presentable &&
2651 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2652 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2653 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002654 // For each region, the number of layers in the image subresource should not be zero
2655 // For each region, src and dest image aspect must be color only
2656 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002657 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2658 "srcSubresource", i);
2659 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2660 "dstSubresource", i);
Cort Stratton7df30962018-05-17 19:45:57 -07002661 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, src_image_layout,
2662 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2663 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
2664 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dst_image_layout,
2665 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2666 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002667 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2668 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2669 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2670 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2671 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2672 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2673 "VUID-vkCmdResolveImage-srcSubresource-01711");
2674 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2675 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2676 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002677
2678 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002679 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2680 skip |= log_msg(
2681 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002682 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002683 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002684 }
Cort Stratton7df30962018-05-17 19:45:57 -07002685 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002686 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2687 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2688 char const str[] =
2689 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2690 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 -06002691 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002692 }
2693 }
2694
2695 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2696 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002697 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 -06002698 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002699 }
2700 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2701 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002702 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 -06002703 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002704 }
2705 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2706 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2707 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 -06002708 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002709 }
2710 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2711 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2712 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 -06002713 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002714 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002715 } else {
2716 assert(0);
2717 }
2718 return skip;
2719}
2720
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002721void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2722 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002723 // Update bindings between images and cmd buffer
2724 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2725 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002726}
2727
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002728bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002729 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2730 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002731 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2732
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002733 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002734 if (cb_node) {
2735 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2736 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002737 if (cb_node && src_image_state && dst_image_state) {
2738 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002739 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002740 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002741 "VUID-vkCmdBlitImage-dstImage-00234");
2742 skip |=
2743 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2744 skip |=
2745 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
2746 skip |=
2747 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2748 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2749 skip |=
2750 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2751 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2752 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
2753 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002754 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002755 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002756 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002757 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04002758 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002759 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002760
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002761 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002762
Dave Houlton33c2d252017-06-09 17:08:32 -06002763 VkFormat src_format = src_image_state->createInfo.format;
2764 VkFormat dst_format = dst_image_state->createInfo.format;
2765 VkImageType src_type = src_image_state->createInfo.imageType;
2766 VkImageType dst_type = dst_image_state->createInfo.imageType;
2767
Cort Stratton186b1a22018-05-01 20:18:06 -04002768 if (VK_FILTER_LINEAR == filter) {
2769 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002770 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2771 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002772 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002773 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
2774 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002775 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002776 }
2777
2778 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2779 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 -06002780 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002781 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002782 }
2783
Dave Houlton33c2d252017-06-09 17:08:32 -06002784 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2785 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2786 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 -06002787 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002788 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002789 }
2790
2791 // Validate consistency for unsigned formats
2792 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2793 std::stringstream ss;
2794 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2795 << "the other one must also have unsigned integer format. "
2796 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2797 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 -06002798 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002799 }
2800
2801 // Validate consistency for signed formats
2802 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2803 std::stringstream ss;
2804 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2805 << "the other one must also have signed integer format. "
2806 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2807 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 -06002808 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002809 }
2810
2811 // Validate filter for Depth/Stencil formats
2812 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2813 std::stringstream ss;
2814 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2815 << "then filter must be VK_FILTER_NEAREST.";
2816 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 -06002817 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002818 }
2819
2820 // Validate aspect bits and formats for depth/stencil images
2821 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2822 if (src_format != dst_format) {
2823 std::stringstream ss;
2824 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2825 << "stencil, the other one must have exactly the same format. "
2826 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2827 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06002828 skip |=
2829 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2830 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002831 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002832 } // Depth or Stencil
2833
2834 // Do per-region checks
Cort Stratton7df30962018-05-17 19:45:57 -07002835 const std::string invalid_src_layout_vuid =
2836 (src_image_state->shared_presentable &&
2837 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2838 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
2839 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
2840 const std::string invalid_dst_layout_vuid =
2841 (dst_image_state->shared_presentable &&
2842 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2843 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
2844 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002845 for (uint32_t i = 0; i < region_count; i++) {
2846 const VkImageBlit rgn = regions[i];
2847 bool hit_error = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06002848 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002849 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
2850 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Dave Houltond8ed0212018-05-16 17:18:24 -06002851 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002852 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
2853 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07002854 skip |=
2855 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
2856 skip |=
2857 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002858 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
2859 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
2860 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
2861 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
2862 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
2863 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
2864 "VUID-vkCmdBlitImage-srcSubresource-01707");
2865 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
2866 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
2867 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002868 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002869 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2870 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002871 std::stringstream ss;
2872 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06002873 skip |=
2874 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2875 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002876 }
Dave Houlton48989f32017-05-26 15:01:46 -06002877 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2878 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002879 std::stringstream ss;
2880 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06002881 skip |=
2882 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2883 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002884 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002885
2886 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002887 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002888 skip |=
2889 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002890 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002891 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002892 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002893
Dave Houlton48989f32017-05-26 15:01:46 -06002894 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002895 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 -06002896 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002897 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002898 }
Dave Houlton48989f32017-05-26 15:01:46 -06002899
Dave Houlton33c2d252017-06-09 17:08:32 -06002900 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2901 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 -06002902 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Dave Houlton33c2d252017-06-09 17:08:32 -06002903 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002904 "image format %s.",
2905 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002906 }
2907
2908 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2909 skip |= log_msg(
2910 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002911 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002912 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
2913 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002914 }
2915
Dave Houlton48989f32017-05-26 15:01:46 -06002916 // Validate source image offsets
2917 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002918 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002919 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2920 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 -06002921 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
Dave Houlton48989f32017-05-26 15:01:46 -06002922 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002923 "of (%1d, %1d). These must be (0, 1).",
2924 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002925 }
2926 }
2927
Dave Houlton33c2d252017-06-09 17:08:32 -06002928 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002929 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2930 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 -06002931 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Dave Houlton48989f32017-05-26 15:01:46 -06002932 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002933 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
2934 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002935 }
2936 }
2937
Dave Houlton33c2d252017-06-09 17:08:32 -06002938 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002939 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2940 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002941 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002942 skip |=
2943 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002944 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002945 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
2946 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002947 }
2948 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2949 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002950 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002951 skip |= log_msg(
2952 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002953 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002954 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
2955 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002956 }
2957 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2958 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002959 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002960 skip |=
2961 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002962 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002963 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
2964 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002965 }
Cort Strattonff1542a2018-05-27 10:49:28 -07002966 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002967 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 -06002968 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002969 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06002970 }
Dave Houlton48989f32017-05-26 15:01:46 -06002971
2972 // Validate dest image offsets
2973 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002974 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002975 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2976 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 -06002977 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
Dave Houlton48989f32017-05-26 15:01:46 -06002978 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002979 "(%1d, %1d). These must be (0, 1).",
2980 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002981 }
2982 }
2983
Dave Houlton33c2d252017-06-09 17:08:32 -06002984 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002985 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2986 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 -06002987 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Dave Houlton48989f32017-05-26 15:01:46 -06002988 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002989 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
2990 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002991 }
2992 }
2993
Dave Houlton33c2d252017-06-09 17:08:32 -06002994 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002995 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2996 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002997 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002998 skip |=
2999 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003000 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003001 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
3002 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003003 }
3004 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3005 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003006 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003007 skip |= log_msg(
3008 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003009 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003010 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
3011 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003012 }
3013 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3014 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003015 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003016 skip |=
3017 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003018 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003019 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
3020 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003021 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003022 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003023 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003024 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003025 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003026 }
3027
Dave Houlton33c2d252017-06-09 17:08:32 -06003028 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3029 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3030 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
3031 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 -06003032 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
Dave Houlton33c2d252017-06-09 17:08:32 -06003033 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003034 "layerCount other than 1.",
3035 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003036 }
3037 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003038 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003039 } else {
3040 assert(0);
3041 }
3042 return skip;
3043}
3044
Tobin Ehlis58c884f2017-02-08 12:15:27 -07003045void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003046 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
3047 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
3048 // Make sure that all image slices are updated to correct layout
3049 for (uint32_t i = 0; i < region_count; ++i) {
3050 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
3051 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
3052 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003053 // Update bindings between images and cmd buffer
3054 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3055 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003056}
3057
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003058// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07003059bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003060 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3061 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003062 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07003063 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003064 for (auto cb_image_data : pCB->imageLayoutMap) {
3065 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003066
Dave Houltonb3f4b282018-02-22 16:25:16 -07003067 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3068 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003069 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3070 // TODO: Set memory invalid which is in mem_tracker currently
3071 } else if (imageLayout != cb_image_data.second.initialLayout) {
3072 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003073 skip |= log_msg(
3074 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003075 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003076 "Submitted command buffer expects image 0x%" PRIx64
3077 " (subresource: aspectMask 0x%X array layer %u, mip level %u) to be in layout %s--instead, image 0x%" PRIx64
3078 "'s current layout is %s.",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003079 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
3080 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003081 string_VkImageLayout(cb_image_data.second.initialLayout), HandleToUint64(cb_image_data.first.image),
3082 string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003083 } else {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003084 skip |=
3085 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3086 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3087 "Submitted command buffer expects image 0x%" PRIx64 " to be in layout %s--instead, image 0x%" PRIx64
3088 "'s current layout is %s.",
3089 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(cb_image_data.second.initialLayout),
3090 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003091 }
3092 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003093 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003094 }
3095 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003096 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003097}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003098
Tony Barbourdf013b92017-01-25 12:53:48 -07003099void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
3100 for (auto cb_image_data : pCB->imageLayoutMap) {
3101 VkImageLayout imageLayout;
3102 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3103 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3104 }
3105}
3106
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003107// Print readable FlagBits in FlagMask
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003108static std::string StringVkAccessFlags(VkAccessFlags accessMask) {
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003109 std::string result;
3110 std::string separator;
3111
3112 if (accessMask == 0) {
3113 result = "[None]";
3114 } else {
3115 result = "[";
3116 for (auto i = 0; i < 32; i++) {
3117 if (accessMask & (1 << i)) {
3118 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
3119 separator = " | ";
3120 }
3121 }
3122 result = result + "]";
3123 }
3124 return result;
3125}
3126
Dave Houlton12befb92018-06-26 17:16:46 -06003127#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 -06003128 // validation ToBeRemoved (disabled 6/18)
Dave Houlton12befb92018-06-26 17:16:46 -06003129
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003130// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
3131// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003132// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003133static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
3134 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
3135 const char *type) {
3136 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3137 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003138
3139 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
3140 if (accessMask & ~(required_bit | optional_bits)) {
3141 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003142 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 -06003143 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003144 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003145 StringVkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003146 }
3147 } else {
3148 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003149 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 -06003150 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003151 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
3152 "has previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003153 type, accessMask, StringVkAccessFlags(accessMask).c_str(), optional_bits,
3154 StringVkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003155 } else {
3156 std::string opt_bits;
3157 if (optional_bits != 0) {
3158 std::stringstream ss;
3159 ss << optional_bits;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003160 opt_bits = "and may have optional bits " + ss.str() + ' ' + StringVkAccessFlags(optional_bits);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003161 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003162 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 -06003163 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003164 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
3165 "previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003166 type, accessMask, StringVkAccessFlags(accessMask).c_str(), required_bit,
3167 StringVkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003168 }
3169 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003170 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003171}
Dave Houlton12befb92018-06-26 17:16:46 -06003172#endif
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003173
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003174// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003175// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3176// layout attachments don't have CLEAR as their loadOp.
Tobias Hectorbbb12282018-10-22 15:17:59 +01003177bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3178 const VkImageLayout first_layout, const uint32_t attachment,
3179 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003180 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003181 const char *vuid;
3182 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3183
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003184 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3185 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3186 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3187 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003188 vuid =
3189 use_rp2 ? "VUID-VkRenderPassCreateInfo2KHR-pAttachments-03053" : "VUID-VkRenderPassCreateInfo-pAttachments-00836";
Dave Houltond8ed0212018-05-16 17:18:24 -06003190 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003191 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003192 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003193 }
3194 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003195 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3196 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003197 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003198 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003199 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003200 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003201 }
3202 }
3203
3204 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3205 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003206 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003207 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003208 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003209 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003210 }
3211 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003212 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003213}
3214
Tobias Hectorbbb12282018-10-22 15:17:59 +01003215bool ValidateLayouts(const core_validation::layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3216 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003217 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003218 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003219 const char *vuid;
3220 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3221 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003222
Jason Ekstranda1906302017-12-03 20:16:32 -08003223 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3224 VkFormat format = pCreateInfo->pAttachments[i].format;
3225 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3226 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3227 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003228 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 -06003229 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003230 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3231 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3232 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3233 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003234 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003235 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003236 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 -06003237 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003238 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3239 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3240 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3241 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003242 }
3243 }
3244 }
3245
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003246 // Track when we're observing the first use of an attachment
3247 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3248 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003249 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003250
3251 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3252 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3253 auto attach_index = subpass.pInputAttachments[j].attachment;
3254 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003255 switch (subpass.pInputAttachments[j].layout) {
3256 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3257 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3258 // These are ideal.
3259 break;
3260
3261 case VK_IMAGE_LAYOUT_GENERAL:
3262 // May not be optimal. TODO: reconsider this warning based on other constraints.
3263 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003264 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003265 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3266 break;
3267
Tobias Hectorbbb12282018-10-22 15:17:59 +01003268 case VK_IMAGE_LAYOUT_UNDEFINED:
3269 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3270 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3271 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3272 "Layout for input attachment reference %u in subpass %u is %s but must be "
3273 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3274 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3275 break;
3276
Graeme Leese668a9862018-10-08 10:40:02 +01003277 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3278 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3279 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3280 break;
3281 } else {
3282 // Intentionally fall through to generic error message
3283 }
3284 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003285
Cort Stratton7547f772017-05-04 15:18:52 -07003286 default:
3287 // No other layouts are acceptable
3288 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 -06003289 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003290 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3291 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3292 }
3293
Cort Stratton7547f772017-05-04 15:18:52 -07003294 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003295 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3296 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003297
3298 bool used_as_depth =
3299 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3300 bool used_as_color = false;
3301 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3302 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3303 }
3304 if (!used_as_depth && !used_as_color &&
3305 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003306 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3307 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3308 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3309 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003310 }
3311 }
3312 attach_first_use[attach_index] = false;
3313 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003314
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003315 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3316 auto attach_index = subpass.pColorAttachments[j].attachment;
3317 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3318
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003319 // TODO: Need a way to validate shared presentable images here, currently just allowing
3320 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3321 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003322 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003323 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003324 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003325 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3326 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003327 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003328
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003329 case VK_IMAGE_LAYOUT_GENERAL:
3330 // May not be optimal; TODO: reconsider this warning based on other constraints?
3331 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003332 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003333 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3334 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003335
Tobias Hectorbbb12282018-10-22 15:17:59 +01003336 case VK_IMAGE_LAYOUT_UNDEFINED:
3337 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3338 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3339 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3340 "Layout for color attachment reference %u in subpass %u is %s but should be "
3341 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3342 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3343 break;
3344
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003345 default:
3346 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 -06003347 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003348 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3349 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003350 }
3351
Tobias Hectorbbb12282018-10-22 15:17:59 +01003352 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3353 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
3354 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3356 "Layout for color attachment reference %u in subpass %u is %s but should be "
3357 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3358 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3359 }
3360
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003361 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003362 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3363 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003364 }
3365 attach_first_use[attach_index] = false;
3366 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003367
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003368 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3369 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003370 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3371 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3372 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003373 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003374
Dave Houltona9df0ce2018-02-07 10:51:23 -07003375 case VK_IMAGE_LAYOUT_GENERAL:
3376 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3377 // doing a bunch of transitions.
3378 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003379 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003380 "GENERAL layout for depth attachment may not give optimal performance.");
3381 break;
3382
Tobias Hectorbbb12282018-10-22 15:17:59 +01003383 case VK_IMAGE_LAYOUT_UNDEFINED:
3384 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3385 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3386 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3387 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3388 "layout or GENERAL.",
3389 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3390 break;
3391
Dave Houltona9df0ce2018-02-07 10:51:23 -07003392 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3393 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3394 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3395 break;
3396 } else {
3397 // Intentionally fall through to generic error message
3398 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003399 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003400
Dave Houltona9df0ce2018-02-07 10:51:23 -07003401 default:
3402 // No other layouts are acceptable
3403 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 -06003404 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003405 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3406 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3407 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003408 }
3409
3410 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3411 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003412 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3413 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003414 }
3415 attach_first_use[attach_index] = false;
3416 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003417 }
3418 return skip;
3419}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003420
3421// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003422bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3423 VkDeviceSize offset, VkDeviceSize end_offset) {
3424 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3425 bool skip = false;
3426 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3427 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003428 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3429 for (auto image_handle : mem_info->bound_images) {
3430 auto img_it = mem_info->bound_ranges.find(image_handle);
3431 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003432 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003433 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003434 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003435 for (auto layout : layouts) {
3436 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003437 skip |=
3438 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 -06003439 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003440 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3441 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003442 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003443 }
3444 }
3445 }
3446 }
3447 }
3448 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003449 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003450}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003451
3452// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3453// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003454static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3455 VulkanObjectType obj_type, std::string msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003456 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003457
3458 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003459 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003460 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003461 if (strict) {
3462 correct_usage = ((actual & desired) == desired);
3463 } else {
3464 correct_usage = ((actual & desired) != 0);
3465 }
3466 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003467 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003468 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003469 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003470 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 -06003471 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003472 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3473 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003474 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003475 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003476 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 -06003477 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3478 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003479 }
3480 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003481 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003482}
3483
3484// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3485// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003486bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003487 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003488 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3489 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003490}
3491
Cort Stratton186b1a22018-05-01 20:18:06 -04003492bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Dave Houltone0969282018-05-23 15:54:31 -06003493 char const *func_name, const std::string &linear_vuid, const std::string &optimal_vuid) {
Cort Stratton186b1a22018-05-01 20:18:06 -04003494 VkFormatProperties format_properties = GetFormatProperties(dev_data, image_state->createInfo.format);
3495 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3496 bool skip = false;
3497 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3498 if ((format_properties.linearTilingFeatures & desired) != desired) {
3499 skip |=
3500 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3501 HandleToUint64(image_state->image), linear_vuid,
3502 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3503 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3504 }
3505 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3506 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3507 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3508 HandleToUint64(image_state->image), optimal_vuid,
3509 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3510 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3511 HandleToUint64(image_state->image));
3512 }
3513 }
3514 return skip;
3515}
3516
Cort Strattond619a302018-05-17 19:46:32 -07003517bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3518 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3519 uint32_t i) {
3520 bool skip = false;
3521 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3522 // layerCount must not be zero
3523 if (subresource_layers->layerCount == 0) {
3524 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3525 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3526 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3527 }
3528 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3529 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3530 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3531 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3532 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3533 }
3534 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3535 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3536 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3537 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3538 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3539 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3540 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3541 func_name, i, member);
3542 }
3543 return skip;
3544}
3545
Mark Lobodzinski96210742017-02-09 10:33:46 -07003546// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3547// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003548bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003549 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003550 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3551 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003552}
3553
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003554bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3555 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3556 bool skip = false;
3557 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3558
3559 const VkDeviceSize &range = pCreateInfo->range;
3560 if (range != VK_WHOLE_SIZE) {
3561 // Range must be greater than 0
3562 if (range <= 0) {
3563 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3564 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3565 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3566 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3567 range);
3568 }
3569 // Range must be a multiple of the element size of format
3570 const size_t format_size = FormatSize(pCreateInfo->format);
3571 if (range % format_size != 0) {
3572 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3573 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3574 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3575 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3576 "(" PRINTF_SIZE_T_SPECIFIER ").",
3577 range, format_size);
3578 }
3579 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3580 if (range / format_size > device_limits->maxTexelBufferElements) {
3581 skip |=
3582 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3583 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3584 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3585 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3586 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3587 range, format_size, device_limits->maxTexelBufferElements);
3588 }
3589 // The sum of range and offset must be less than or equal to the size of buffer
3590 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3591 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3592 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3593 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3594 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3595 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3596 range, pCreateInfo->offset, buffer_state->createInfo.size);
3597 }
3598 }
3599 return skip;
3600}
3601
Shannon McPherson265383a2018-06-21 15:37:52 -06003602bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3603 const VkBufferViewCreateInfo *pCreateInfo) {
3604 bool skip = false;
3605 const debug_report_data *report_data = GetReportData(device_data);
3606 const VkFormatProperties format_properties = GetFormatProperties(device_data, pCreateInfo->format);
3607 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3608 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3609 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3610 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3611 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3612 "be supported for uniform texel buffers");
3613 }
3614 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3615 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3616 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3617 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3618 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3619 "be supported for storage texel buffers");
3620 }
3621 return skip;
3622}
3623
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003624bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003625 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003626 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3627
Dave Houltond8ed0212018-05-16 17:18:24 -06003628 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003629
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003630 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003631 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 -06003632 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003633 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003634 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003635 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003636
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003637 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3638 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003639 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 -06003640 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003641 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003642 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003643 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003644
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003645 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3646 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003647 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 -06003648 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003649 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003650 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003651 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003652 return skip;
3653}
3654
3655void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3656 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3657 GetBufferMap(device_data)
3658 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3659}
3660
Shannon McPhersona84241a2018-06-18 15:34:46 -06003661bool PreCallValidateCreateBufferView(const layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003662 bool skip = false;
Shannon McPherson883f6092018-06-14 13:15:25 -06003663 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003664 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003665 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3666 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003667 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3668 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003669 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3670 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003671 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3672 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3673 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3674 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003675
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003676 // Buffer view offset must be less than the size of buffer
3677 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3678 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3679 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3680 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3681 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3682 pCreateInfo->offset, buffer_state->createInfo.size);
3683 }
3684
Shannon McPherson883f6092018-06-14 13:15:25 -06003685 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
3686 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3687 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3689 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3690 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3691 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3692 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3693 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003694
3695 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003696
3697 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003698 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003699 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003700}
3701
3702void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3703 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3704}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003705
3706// For the given format verify that the aspect masks make sense
Tobias Hectorbbb12282018-10-22 15:17:59 +01003707bool ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3708 const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003709 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3710 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003711 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3712 if (image != VK_NULL_HANDLE) {
3713 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3714 }
3715
Dave Houlton1d2022c2017-03-29 11:43:58 -06003716 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003717 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003718 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003719 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003720 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003721 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003722 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003723 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003724 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003725 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003726 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003727 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003728 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3729 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003730 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003731 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003732 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003733 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3734 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003735 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003736 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003737 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003738 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003739 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003740 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003741 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003742 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003743 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003744 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003745 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003746 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003747 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003748 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003749 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003750 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003751 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003752 } else if (FormatIsMultiplane(format)) {
3753 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3754 if (3 == FormatPlaneCount(format)) {
3755 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3756 }
3757 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003758 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003759 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3760 "set, where n = [0, 1, 2].",
3761 func_name);
3762 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003763 }
3764 return skip;
3765}
3766
Petr Krausffa94af2017-08-08 21:46:02 +02003767struct SubresourceRangeErrorCodes {
Dave Houltond8ed0212018-05-16 17:18:24 -06003768 std::string base_mip_err, mip_count_err, base_layer_err, layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02003769};
3770
3771bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3772 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3773 const char *image_layer_count_var_name, const uint64_t image_handle,
3774 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003775 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3776 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003777
3778 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003779 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003780 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 -06003781 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003782 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003783 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3784 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003785 }
Petr Kraus4d718682017-05-18 03:38:41 +02003786
Petr Krausffa94af2017-08-08 21:46:02 +02003787 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3788 if (subresourceRange.levelCount == 0) {
3789 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 -06003790 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003791 } else {
3792 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003793
Petr Krausffa94af2017-08-08 21:46:02 +02003794 if (necessary_mip_count > image_mip_count) {
3795 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 -06003796 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003797 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003798 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003799 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003800 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003801 }
Petr Kraus4d718682017-05-18 03:38:41 +02003802 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003803 }
Petr Kraus4d718682017-05-18 03:38:41 +02003804
3805 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003806 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003807 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 -06003808 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003809 "%s: %s.baseArrayLayer (= %" PRIu32
3810 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3811 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003812 }
Petr Kraus4d718682017-05-18 03:38:41 +02003813
Petr Krausffa94af2017-08-08 21:46:02 +02003814 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3815 if (subresourceRange.layerCount == 0) {
3816 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 -06003817 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003818 } else {
3819 const uint64_t necessary_layer_count =
3820 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003821
Petr Krausffa94af2017-08-08 21:46:02 +02003822 if (necessary_layer_count > image_layer_count) {
3823 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 -06003824 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003825 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003826 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003827 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003828 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003829 }
Petr Kraus4d718682017-05-18 03:38:41 +02003830 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003831 }
Petr Kraus4d718682017-05-18 03:38:41 +02003832
Mark Lobodzinski602de982017-02-09 11:01:33 -07003833 return skip;
3834}
3835
Petr Krausffa94af2017-08-08 21:46:02 +02003836bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3837 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3838 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3839 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3840 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3841 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3842
3843 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3844 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3845
3846 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003847 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
3848 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
3849 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
3850 : "VUID-VkImageViewCreateInfo-image-01482")
3851 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
3852 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
3853 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
3854 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
3855 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02003856
3857 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3858 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3859 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3860}
3861
3862bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3863 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3864 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003865 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
3866 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
3867 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
3868 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02003869
3870 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3871 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3872 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3873}
3874
3875bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3876 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3877 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003878 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
3879 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
3880 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
3881 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02003882
3883 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3884 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3885 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3886}
3887
3888bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3889 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3890 const char *param_name) {
3891 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003892 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
3893 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
3894 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
3895 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02003896
3897 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3898 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3899 subresourceRangeErrorCodes);
3900}
3901
Mark Lobodzinski602de982017-02-09 11:01:33 -07003902bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3903 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3904 bool skip = false;
3905 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3906 if (image_state) {
3907 skip |= ValidateImageUsageFlags(
3908 device_data, image_state,
3909 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06003910 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
3911 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06003912 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05003913 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07003914 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06003915 skip |=
3916 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07003917 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003918 skip |= ValidateCreateImageViewSubresourceRange(
3919 device_data, image_state,
3920 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3921 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003922
3923 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3924 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003925 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3926 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003927 VkFormat view_format = create_info->format;
3928 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003929 VkImageType image_type = image_state->createInfo.imageType;
3930 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003931
Dave Houltonbd2e2622018-04-10 16:41:14 -06003932 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
3933 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
3934 if (chained_ivuci_struct) {
3935 if (chained_ivuci_struct->usage & ~image_usage) {
3936 std::stringstream ss;
3937 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06003938 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06003939 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06003940 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3941 HandleToUint64(create_info->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
3942 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06003943 }
3944
3945 image_usage = chained_ivuci_struct->usage;
3946 }
3947
Dave Houlton6f5f20a2018-05-04 12:37:44 -06003948 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
3949 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06003950 if (FormatIsMultiplane(image_format)) {
3951 // View format must match the multiplane compatible format
3952 uint32_t plane = 3; // invalid
3953 switch (aspect_mask) {
3954 case VK_IMAGE_ASPECT_PLANE_0_BIT:
3955 plane = 0;
3956 break;
3957 case VK_IMAGE_ASPECT_PLANE_1_BIT:
3958 plane = 1;
3959 break;
3960 case VK_IMAGE_ASPECT_PLANE_2_BIT:
3961 plane = 2;
3962 break;
3963 default:
3964 break;
3965 }
3966
3967 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
3968 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003969 std::stringstream ss;
3970 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06003971 << " is not compatible with plane " << plane << " of underlying image format "
3972 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06003973 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3974 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
3975 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06003976 }
3977 } else {
3978 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3979 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3980 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3981 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3982 std::stringstream ss;
3983 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3984 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3985 << ") format " << string_VkFormat(image_format)
3986 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3987 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06003988 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3989 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
3990 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06003991 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003992 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003993 }
3994 } else {
3995 // Format MUST be IDENTICAL to the format the image was created with
3996 if (image_format != view_format) {
3997 std::stringstream ss;
3998 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003999 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004000 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004001 skip |=
4002 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4003 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004004 }
4005 }
4006
4007 // Validate correct image aspect bits for desired formats and format consistency
4008 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004009
4010 switch (image_type) {
4011 case VK_IMAGE_TYPE_1D:
4012 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004013 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4014 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004015 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4016 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004017 }
4018 break;
4019 case VK_IMAGE_TYPE_2D:
4020 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4021 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4022 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004023 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4024 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004025 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4026 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004027 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004028 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4029 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004030 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4031 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004032 }
4033 }
4034 break;
4035 case VK_IMAGE_TYPE_3D:
4036 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4037 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4038 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4039 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004040 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004041 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4042 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004043 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4044 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004045 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4046 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004047 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004048 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4049 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004050 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4051 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004052 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4053 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004054 }
4055 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004056 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4057 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004058 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4059 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004060 }
4061 }
4062 } else {
4063 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004064 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4065 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004066 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4067 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004068 }
4069 }
4070 break;
4071 default:
4072 break;
4073 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004074
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06004075 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004076 bool check_tiling_features = false;
4077 VkFormatFeatureFlags tiling_features = 0;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004078 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06004079 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004080 check_tiling_features = true;
4081 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06004082 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004083 check_tiling_features = true;
4084 }
4085
4086 if (check_tiling_features) {
4087 if (tiling_features == 0) {
Mark Young9d1ac312018-05-21 16:28:27 -06004088 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06004089 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-None-02273",
Mark Young9d1ac312018-05-21 16:28:27 -06004090 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set.",
4091 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004092 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004093 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06004094 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02274",
Mark Young9d1ac312018-05-21 16:28:27 -06004095 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
4096 "VK_IMAGE_USAGE_SAMPLED_BIT flags set.",
4097 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004098 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004099 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06004100 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02275",
Mark Young9d1ac312018-05-21 16:28:27 -06004101 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
4102 "VK_IMAGE_USAGE_STORAGE_BIT flags set.",
4103 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004104 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4105 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004106 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06004107 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02276",
Mark Young9d1ac312018-05-21 16:28:27 -06004108 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
4109 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set.",
4110 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004111 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4112 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004113 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06004114 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02277",
Mark Young9d1ac312018-05-21 16:28:27 -06004115 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
4116 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set.",
4117 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004118 }
4119 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05004120 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4121 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4122 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4123 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02086",
4124 "vkCreateImageView() If image was created with usage containing "
4125 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4126 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4127 }
4128 if (view_format != VK_FORMAT_R8_UINT) {
4129 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4130 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02087",
4131 "vkCreateImageView() If image was created with usage containing "
4132 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4133 }
4134 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004135 }
4136 return skip;
4137}
4138
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004139void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
4140 auto image_view_map = GetImageViewMap(device_data);
4141 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
4142
4143 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004144 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004145 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4146 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004147}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004148
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004149bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4150 BUFFER_STATE *dst_buffer_state) {
4151 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004152 skip |=
4153 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4154 skip |=
4155 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004156 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004157 skip |=
4158 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4159 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4160 skip |=
4161 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4162 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004163 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004164 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4165 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004166 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004167 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004168 return skip;
4169}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004170
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004171void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4172 BUFFER_STATE *dst_buffer_state) {
4173 // Update bindings between buffers and cmd buffer
4174 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4175 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004176}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004177
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004178static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004179 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4180 bool skip = false;
4181 auto buffer_state = GetBufferState(device_data, buffer);
4182 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004183 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 -06004184 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01004185 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004186 } else {
4187 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004188 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 -06004189 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004190 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004191 }
4192 }
4193 return skip;
4194}
4195
4196bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
4197 VK_OBJECT *obj_struct) {
4198 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004199 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004200 if (GetDisables(device_data)->destroy_image_view) return false;
4201 bool skip = false;
4202 if (*image_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004203 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView",
4204 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004205 }
4206 return skip;
4207}
4208
John Zulauffca05c12018-04-26 16:30:39 -06004209void PreCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
4210 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004211 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004212 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004213 (*GetImageViewMap(device_data)).erase(image_view);
4214}
4215
4216bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
4217 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02004218 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004219 if (GetDisables(device_data)->destroy_buffer) return false;
4220 bool skip = false;
4221 if (*buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004222 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004223 }
4224 return skip;
4225}
4226
John Zulauffca05c12018-04-26 16:30:39 -06004227void PreCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004228 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004229 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4230 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4231 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004232 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004233 }
4234 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004235 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004236 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004237 GetBufferMap(device_data)->erase(buffer_state->buffer);
4238}
4239
4240bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
4241 VK_OBJECT *obj_struct) {
4242 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004243 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004244 if (GetDisables(device_data)->destroy_buffer_view) return false;
4245 bool skip = false;
4246 if (*buffer_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004247 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView",
4248 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004249 }
4250 return skip;
4251}
4252
John Zulauffca05c12018-04-26 16:30:39 -06004253void PreCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
4254 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004255 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004256 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004257 GetBufferViewMap(device_data)->erase(buffer_view);
4258}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004259
4260bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
4261 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004262 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004263 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004264 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4265 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004266 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4267 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004268 skip |=
4269 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4270 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004271 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004272 return skip;
4273}
4274
4275void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004276 // Update bindings between buffer and cmd buffer
4277 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004278}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004279
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004280bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4281 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004282 bool skip = false;
4283
4284 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004285 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4286 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004287 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 -06004288 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004289 "%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 -06004290 "and 1, respectively.",
4291 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004292 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004293 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004294
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004295 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4296 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004297 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 -06004298 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004299 "%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 -06004300 "must be 0 and 1, respectively.",
4301 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004302 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004303 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004304
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004305 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4306 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004307 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 -06004308 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004309 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4310 "For 3D images these must be 0 and 1, respectively.",
4311 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004312 }
4313 }
4314
4315 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
4316 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06004317 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06004318 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004319 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 -06004320 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004321 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004322 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
4323 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004324 }
4325
4326 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004327 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004328 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 -06004329 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004330 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4331 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004332 }
4333
4334 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4335 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004336 skip |=
4337 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004338 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004339 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4340 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004341 }
4342
4343 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4344 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4345 skip |= log_msg(
4346 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004347 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004348 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4349 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004350 }
4351
4352 // subresource aspectMask must have exactly 1 bit set
4353 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4354 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4355 if (aspect_mask_bits.count() != 1) {
4356 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 -06004357 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004358 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004359 }
4360
4361 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004362 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004363 skip |= log_msg(
4364 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004365 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004366 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4367 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004368 }
4369
4370 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004371 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004372 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004373
4374 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004375 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004376 skip |= log_msg(
4377 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004378 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004379 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4380 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004381 }
4382
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004383 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004384 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004385 skip |= log_msg(
4386 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004387 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004388 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4389 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004390 }
4391
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004392 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004393 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4394 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4395 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004396 skip |=
4397 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004398 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004399 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4400 "width & height (%d, %d)..",
4401 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004402 }
4403
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004404 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004405 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
4406 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004407 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 -06004408 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004409 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4410 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
4411 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004412 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004413
4414 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004415 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004416 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004417 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4418 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 -06004419 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004420 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004421 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004422 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004423 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004424 }
4425
4426 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004427 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004428 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4429 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 -06004430 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004431 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004432 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004433 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004434 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004435 }
4436
4437 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004438 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004439 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4440 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 -06004441 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004442 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004443 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004444 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004445 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004446 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004447 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004448 }
4449
4450 return skip;
4451}
4452
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004453static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Dave Houltond8ed0212018-05-16 17:18:24 -06004454 const VkBufferImageCopy *pRegions, const char *func_name, std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004455 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004456 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004457
4458 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004459 VkExtent3D extent = pRegions[i].imageExtent;
4460 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004461
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004462 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4463 {
Dave Houlton51653902018-06-22 17:32:13 -06004464 skip |=
4465 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4466 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4467 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004468 }
4469
4470 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4471
4472 // 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 -06004473 if (FormatIsCompressed(image_info->format)) {
4474 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004475 if (image_extent.width % block_extent.width) {
4476 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4477 }
4478 if (image_extent.height % block_extent.height) {
4479 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4480 }
4481 if (image_extent.depth % block_extent.depth) {
4482 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4483 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004484 }
4485
Dave Houltonfc1a4052017-04-27 14:32:45 -06004486 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004487 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 -06004488 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004489 }
4490 }
4491
4492 return skip;
4493}
4494
Chris Forbese8ba09a2017-06-01 17:39:02 -07004495static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004496 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06004497 std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004498 bool skip = false;
4499
4500 VkDeviceSize buffer_size = buff_state->createInfo.size;
4501
4502 for (uint32_t i = 0; i < regionCount; i++) {
4503 VkExtent3D copy_extent = pRegions[i].imageExtent;
4504
4505 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4506 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004507 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004508
Dave Houltonf3229d52017-02-21 15:59:08 -07004509 // Handle special buffer packing rules for specific depth/stencil formats
4510 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004511 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004512 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4513 switch (image_state->createInfo.format) {
4514 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004515 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004516 break;
4517 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004518 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004519 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004520 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004521 case VK_FORMAT_D24_UNORM_S8_UINT:
4522 unit_size = 4;
4523 break;
4524 default:
4525 break;
4526 }
4527 }
4528
Tom Cooperb2550c72018-10-15 13:08:41 +01004529 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004530 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06004531 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004532 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4533 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4534
4535 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4536 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4537 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004538 }
4539
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004540 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4541 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4542 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004543 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004544 } else {
4545 // Calculate buffer offset of final copied byte, + 1.
4546 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4547 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4548 max_buffer_offset *= unit_size; // convert to bytes
4549 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004550
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004551 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004552 skip |=
4553 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4554 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004555 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004556 }
4557 }
4558
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004559 return skip;
4560}
4561
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004562bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004563 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004564 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004565 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4566 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4567
4568 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004569 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004570
4571 // Command pool must support graphics, compute, or transfer operations
4572 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4573
4574 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4575 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4576 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 -06004577 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004578 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004579 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004580 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004581 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004582 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004583 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004584 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004585
4586 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004587 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4588 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4589 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4590 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4591 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004592
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004593 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004594 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4595 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4596 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004597 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004598 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4599 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004600 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4601 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004602 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4603 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004604 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004605 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004606 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004607 const std::string src_invalid_layout_vuid =
4608 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4609 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4610 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004611 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004612 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4613 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004614 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004615 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4616 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004617 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004618 "vkCmdCopyImageToBuffer()",
4619 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004620 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4621 "vkCmdCopyImageToBuffer()", "imageSubresource",
4622 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4623 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4624 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4625 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004626 }
4627 return skip;
4628}
4629
4630void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004631 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4632 VkImageLayout src_image_layout) {
4633 // Make sure that all image slices are updated to correct layout
4634 for (uint32_t i = 0; i < region_count; ++i) {
4635 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4636 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004637 // Update bindings between buffer/image and cmd buffer
4638 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004639 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004640}
4641
4642bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004643 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004644 const VkBufferImageCopy *pRegions, const char *func_name) {
4645 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4646 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4647
4648 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004649 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004650
4651 // Command pool must support graphics, compute, or transfer operations
4652 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4653 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4654 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4655 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 -06004656 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004657 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004658 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004659 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004660 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004661 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004662 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004663 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004664 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004665 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4666 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4667 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4668 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4669 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004670 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004671 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4672 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4673 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4674 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4675 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004676 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4677 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004678 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4679 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004680 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004681 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004682 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004683 const std::string dst_invalid_layout_vuid =
4684 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4685 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4686 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004687 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004688 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4689 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004690 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004691 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4692 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004693 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004694 "vkCmdCopyBufferToImage()",
4695 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004696 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4697 "vkCmdCopyBufferToImage()", "imageSubresource",
4698 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4699 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4700 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4701 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004702 }
4703 return skip;
4704}
4705
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004706void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004707 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4708 VkImageLayout dst_image_layout) {
4709 // Make sure that all image slices are updated to correct layout
4710 for (uint32_t i = 0; i < region_count; ++i) {
4711 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4712 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004713 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004714 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004715}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004716
4717bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4718 const auto report_data = core_validation::GetReportData(device_data);
4719 bool skip = false;
4720 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4721
Dave Houlton1d960ff2018-01-19 12:17:05 -07004722 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004723 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4724 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4725 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004726 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 -06004727 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004728 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004729 }
4730
4731 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4732 if (!image_entry) {
4733 return skip;
4734 }
4735
Dave Houlton1d960ff2018-01-19 12:17:05 -07004736 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004737 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004738 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4739 "VUID-vkGetImageSubresourceLayout-image-00996",
4740 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004741 }
4742
Dave Houlton1d960ff2018-01-19 12:17:05 -07004743 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004744 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004745 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4746 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4747 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4748 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004749 }
4750
Dave Houlton1d960ff2018-01-19 12:17:05 -07004751 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004752 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004753 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4754 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4755 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4756 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004757 }
4758
Dave Houlton1d960ff2018-01-19 12:17:05 -07004759 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004760 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004761 if (FormatIsMultiplane(img_format)) {
4762 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Dave Houltond8ed0212018-05-16 17:18:24 -06004763 std::string vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004764 if (FormatPlaneCount(img_format) > 2u) {
4765 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004766 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004767 }
4768 if (sub_aspect != (sub_aspect & allowed_flags)) {
4769 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 -06004770 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004771 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004772 ") must be a single-plane specifier flag.",
4773 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004774 }
4775 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004776 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004777 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004778 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004779 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004780 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004781 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004782 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004783 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004784 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 -06004785 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004786 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004787 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004788 }
4789 }
4790 return skip;
4791}