blob: a61bd33b302ecefe8f385b99f6966c6d585e5d00 [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
300void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
301 auto view_state = GetImageViewState(device_data, imageView);
302 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
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700317bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700318 const VkRenderPassBeginInfo *pRenderPassBegin,
319 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600320 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700321 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700322 auto const &framebufferInfo = framebuffer_state->createInfo;
323 const auto report_data = core_validation::GetReportData(device_data);
324 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600325 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 -0600326 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700327 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700328 }
329 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
330 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700331 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700332 assert(view_state);
333 const VkImage &image = view_state->create_info.image;
334 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700335 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700336 // TODO: Do not iterate over every possibility - consolidate where possible
337 for (uint32_t j = 0; j < subRange.levelCount; j++) {
338 uint32_t level = subRange.baseMipLevel + j;
339 for (uint32_t k = 0; k < subRange.layerCount; k++) {
340 uint32_t layer = subRange.baseArrayLayer + k;
341 VkImageSubresource sub = {subRange.aspectMask, level, layer};
342 IMAGE_CMD_BUF_LAYOUT_NODE node;
343 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700344 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700345 continue;
346 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700347 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600348 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 -0600349 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700350 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
351 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
352 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600353 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700354 }
355 }
356 }
357 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600358 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700359}
360
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700361void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700362 VkAttachmentReference ref) {
363 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
364 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
365 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
366 }
367}
368
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700369void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700370 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700371 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700372
373 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700374 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700375 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
376 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
377 }
378 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
379 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
380 }
381 if (subpass.pDepthStencilAttachment) {
382 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
383 }
384 }
385}
386
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600387bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700388 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700389 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
390 return false;
391 }
392 VkImageSubresource sub = {aspect, level, layer};
393 IMAGE_CMD_BUF_LAYOUT_NODE node;
394 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700395 return false;
396 }
397 bool skip = false;
398 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
399 // TODO: Set memory invalid which is in mem_tracker currently
400 } else if (node.layout != mem_barrier->oldLayout) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600401 skip = log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
402 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
403 "VUID-VkImageMemoryBarrier-oldLayout-01197",
404 "For image 0x%" PRIx64
405 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
406 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
407 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700408 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700409 return skip;
410}
411
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700412// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
413// 1. Transition into initialLayout state
414// 2. Transition from initialLayout to layout used in subpass 0
415void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
416 FRAMEBUFFER_STATE *framebuffer_state) {
417 // First transition into initialLayout
418 auto const rpci = render_pass_state->createInfo.ptr();
419 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
420 VkImageView image_view = framebuffer_state->createInfo.pAttachments[i];
421 SetImageViewLayout(device_data, cb_state, image_view, rpci->pAttachments[i].initialLayout);
422 }
423 // Now transition for first subpass (index 0)
424 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
425}
426
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700427void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
428 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
429 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
430 return;
431 }
432 VkImageSubresource sub = {aspect, level, layer};
433 IMAGE_CMD_BUF_LAYOUT_NODE node;
434 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700435 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700436 SetLayout(device_data, pCB, mem_barrier->image, sub,
437 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
438 return;
439 }
440 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
441 // TODO: Set memory invalid
442 }
443 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
444}
445
Dave Houlton10b39482017-03-16 13:18:15 -0600446bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600447 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600448 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600449 }
450 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600451 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600452 }
453 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600454 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600455 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700456 if (0 !=
457 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
458 if (FormatPlaneCount(format) == 1) return false;
459 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600460 return true;
461}
462
Mike Weiblen62d08a32017-03-07 22:18:27 -0700463// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
464bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
465 VkImageUsageFlags usage_flags, const char *func_name) {
466 const auto report_data = core_validation::GetReportData(device_data);
467 bool skip = false;
468 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Dave Houlton8e9f6542018-05-18 12:18:22 -0600469 std::string msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700470
471 switch (layout) {
472 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
473 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600474 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700475 }
476 break;
477 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
478 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600479 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700480 }
481 break;
482 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
483 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600484 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700485 }
486 break;
487 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
488 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600489 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700490 }
491 break;
492 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
493 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600494 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700495 }
496 break;
497 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
498 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600499 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700500 }
501 break;
502 default:
503 // Other VkImageLayout values do not have VUs defined in this context.
504 break;
505 }
506
Dave Houlton8e9f6542018-05-18 12:18:22 -0600507 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600508 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 -0600509 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600510 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
511 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
512 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700513 }
514 return skip;
515}
516
John Zulauf463c51e2018-05-31 13:29:20 -0600517// Scoreboard for checking for duplicate and inconsistent barriers to images
518struct ImageBarrierScoreboardEntry {
519 uint32_t index;
520 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
521 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
522 const VkImageMemoryBarrier *barrier;
523};
524using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
525using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
526
Mike Weiblen62d08a32017-03-07 22:18:27 -0700527// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600528bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700529 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700530 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700531
John Zulauf463c51e2018-05-31 13:29:20 -0600532 // Scoreboard for duplicate layout transition barriers within the list
533 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
534 ImageBarrierScoreboardImageMap layout_transitions;
535
Mike Weiblen62d08a32017-03-07 22:18:27 -0700536 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
537 auto img_barrier = &pImageMemoryBarriers[i];
538 if (!img_barrier) continue;
539
John Zulauf463c51e2018-05-31 13:29:20 -0600540 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
541 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
542 // at a per sub-resource level
543 if (img_barrier->oldLayout != img_barrier->newLayout) {
544 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
545 auto image_it = layout_transitions.find(img_barrier->image);
546 if (image_it != layout_transitions.end()) {
547 auto &subres_map = image_it->second;
548 auto subres_it = subres_map.find(img_barrier->subresourceRange);
549 if (subres_it != subres_map.end()) {
550 auto &entry = subres_it->second;
551 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
552 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
553 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
554 skip = log_msg(
555 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
556 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_state->commandBuffer),
557 "VUID-VkImageMemoryBarrier-oldLayout-01197",
558 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image 0x%" PRIx64
559 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
560 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
561 func_name, i, entry.index, HandleToUint64(img_barrier->image), range.aspectMask, range.baseMipLevel,
562 range.levelCount, range.baseArrayLayer, range.layerCount, string_VkImageLayout(img_barrier->oldLayout),
563 string_VkImageLayout(entry.barrier->newLayout));
564 }
565 entry = new_entry;
566 } else {
567 subres_map[img_barrier->subresourceRange] = new_entry;
568 }
569 } else {
570 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
571 }
572 }
573
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600574 auto image_state = GetImageState(device_data, img_barrier->image);
575 if (image_state) {
576 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
577 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
578 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
579
580 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
581 if (image_state->layout_locked) {
582 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600583 skip |= log_msg(
584 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Young9d1ac312018-05-21 16:28:27 -0600585 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100586 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600587 " 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 +0100588 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600589 string_VkImageLayout(img_barrier->newLayout));
590 }
591 }
592
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600593 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600594 // For a Depth/Stencil image both aspects MUST be set
595 if (FormatIsDepthAndStencil(image_create_info->format)) {
596 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
597 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
598 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600599 skip |=
600 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -0600601 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image),
602 "VUID-VkImageMemoryBarrier-image-01207",
Mark Lobodzinski88529492018-04-01 10:38:15 -0600603 "%s: Image barrier 0x%p references image 0x%" PRIx64
604 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
605 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
606 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600607 }
608 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600609 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
610 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700611
Mike Weiblen62d08a32017-03-07 22:18:27 -0700612 for (uint32_t j = 0; j < level_count; j++) {
613 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
614 for (uint32_t k = 0; k < layer_count; k++) {
615 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600616 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
617 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
618 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
619 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700620 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
621 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
622 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
623 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
624 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
625 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
626 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
627 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700628 }
629 }
630 }
631 return skip;
632}
633
Chris Forbes4de4b132017-08-21 11:27:08 -0700634static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600635 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700636
637 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600638 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700639}
640
John Zulauf6b4aae82018-05-09 13:03:36 -0600641template <typename Barrier>
642bool ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
643 uint32_t barrier_count, const Barrier *barriers) {
644 using BarrierRecord = QFOTransferBarrier<Barrier>;
645 bool skip = false;
646 const auto report_data = core_validation::GetReportData(device_data);
647 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
648 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
649 const char *barrier_name = BarrierRecord::BarrierName();
650 const char *handle_name = BarrierRecord::HandleName();
651 const char *transfer_type = nullptr;
652 for (uint32_t b = 0; b < barrier_count; b++) {
653 if (!IsTransferOp(&barriers[b])) continue;
654 const BarrierRecord *barrier_record = nullptr;
655 if (IsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b])) {
656 const auto found = barrier_sets.release.find(barriers[b]);
657 if (found != barrier_sets.release.cend()) {
658 barrier_record = &(*found);
659 transfer_type = "releasing";
660 }
661 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b])) {
662 const auto found = barrier_sets.acquire.find(barriers[b]);
663 if (found != barrier_sets.acquire.cend()) {
664 barrier_record = &(*found);
665 transfer_type = "acquiring";
666 }
667 }
668 if (barrier_record != nullptr) {
669 skip |=
670 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
671 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
672 "%s: %s at index %" PRIu32 " %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
673 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
674 func_name, barrier_name, b, transfer_type, handle_name, HandleToUint64(barrier_record->handle),
675 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
676 }
677 }
678 return skip;
679}
680
681template <typename Barrier>
682void RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
683 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
684 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
685 for (uint32_t b = 0; b < barrier_count; b++) {
686 if (!IsTransferOp(&barriers[b])) continue;
687 if (IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b])) {
688 barrier_sets.release.emplace(barriers[b]);
689 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b])) {
690 barrier_sets.acquire.emplace(barriers[b]);
691 }
692 }
693}
694
695bool ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
696 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
697 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
698 bool skip = false;
699 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
700 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
701 return skip;
702}
703
704void RecordBarriersQFOTransfers(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
705 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
706 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
707 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
708 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
709}
710
711template <typename BarrierRecord, typename Scoreboard>
712static bool ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
713 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
714 // Record to the scoreboard or report that we have a duplication
715 bool skip = false;
716 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
717 if (!inserted.second && inserted.first->second != cb_state) {
718 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
719 skip = log_msg(
720 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
721 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
722 "%s: %s %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
723 " duplicates existing barrier submitted in this batch from command buffer 0x%" PRIx64 ".",
724 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(), HandleToUint64(barrier.handle),
725 barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex, HandleToUint64(inserted.first->second));
726 }
727 return skip;
728}
729
730template <typename Barrier>
731static bool ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
732 QFOTransferCBScoreboards<Barrier> *scoreboards) {
733 using BarrierRecord = QFOTransferBarrier<Barrier>;
734 using TypeTag = typename BarrierRecord::Tag;
735 bool skip = false;
736 const auto report_data = core_validation::GetReportData(device_data);
737 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
738 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
739 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
740 const char *barrier_name = BarrierRecord::BarrierName();
741 const char *handle_name = BarrierRecord::HandleName();
742 // No release should have an extant duplicate (WARNING)
743 for (const auto &release : cb_barriers.release) {
744 // Check the global pending release barriers
745 const auto set_it = global_release_barriers.find(release.handle);
746 if (set_it != global_release_barriers.cend()) {
747 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
748 const auto found = set_for_handle.find(release);
749 if (found != set_for_handle.cend()) {
750 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
751 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
752 "%s: %s releasing queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
753 " to dstQueueFamilyIndex %" PRIu32
754 " duplicates existing barrier queued for execution, without intervening acquire operation.",
755 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(found->handle),
756 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
757 }
758 }
759 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
760 }
761 // Each acquire must have a matching release (ERROR)
762 for (const auto &acquire : cb_barriers.acquire) {
763 const auto set_it = global_release_barriers.find(acquire.handle);
764 bool matching_release_found = false;
765 if (set_it != global_release_barriers.cend()) {
766 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
767 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
768 }
769 if (!matching_release_found) {
770 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
771 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
772 "%s: in submitted command buffer %s aquiring ownership of %s (0x%" PRIx64
773 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
774 " has no matching release barrier queued for execution.",
775 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(acquire.handle),
776 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
777 }
778 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
779 }
780 return skip;
781}
782
783bool ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
784 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
785 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
786 bool skip = false;
787 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
788 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
789 return skip;
790}
791
792template <typename Barrier>
793static void RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
794 using BarrierRecord = QFOTransferBarrier<Barrier>;
795 using TypeTag = typename BarrierRecord::Tag;
796 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
797 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
798 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
799
800 // Add release barriers from this submit to the global map
801 for (const auto &release : cb_barriers.release) {
802 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
803 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
804 global_release_barriers[release.handle].insert(release);
805 }
806
807 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
808 for (const auto &acquire : cb_barriers.acquire) {
809 // NOTE: We're not using [] because we don't want to create entries for missing releases
810 auto set_it = global_release_barriers.find(acquire.handle);
811 if (set_it != global_release_barriers.end()) {
812 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
813 set_for_handle.erase(acquire);
814 if (set_for_handle.size() == 0) { // Clean up empty sets
815 global_release_barriers.erase(set_it);
816 }
817 }
818 }
819}
820
821void RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
822 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
823 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
824}
825
826// Remove the pending QFO release records from the global set
827// Note that the type of the handle argument constrained to match Barrier type
828// The defaulted BarrierRecord argument allows use to declare the type once, but is not intended to be specified by the caller
829template <typename Barrier, typename BarrierRecord = QFOTransferBarrier<Barrier>>
830static void EraseQFOReleaseBarriers(layer_data *device_data, const typename BarrierRecord::HandleType &handle) {
831 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
832 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, typename BarrierRecord::Tag());
833 global_release_barriers.erase(handle);
834}
835
836// Avoid making the template globally visible by exporting the one instance of it we need.
837void EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
838 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
839}
840
Chris Forbes399a6782017-08-18 15:00:48 -0700841void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700842 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700843 for (uint32_t i = 0; i < memBarrierCount; ++i) {
844 auto mem_barrier = &pImgMemBarriers[i];
845 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700846
Chris Forbes4de4b132017-08-21 11:27:08 -0700847 // For ownership transfers, the barrier is specified twice; as a release
848 // operation on the yielding queue family, and as an acquire operation
849 // on the acquiring queue family. This barrier may also include a layout
850 // transition, which occurs 'between' the two operations. For validation
851 // purposes it doesn't seem important which side performs the layout
852 // transition, but it must not be performed twice. We'll arbitrarily
853 // choose to perform it as part of the acquire operation.
854 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
855 continue;
856 }
857
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600858 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
859 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
860 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
861
Dave Houltonb3f4b282018-02-22 16:25:16 -0700862 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
863 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
864 // for all (potential) layer sub_resources.
865 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
866 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
867 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
868 }
869
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600870 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700871 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600872 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700873 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Chris Forbes399a6782017-08-18 15:00:48 -0700874 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
875 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
876 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
877 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700878 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Chris Forbes399a6782017-08-18 15:00:48 -0700879 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
880 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
881 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700882 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700883 }
884 }
885 }
886}
887
Tobin Ehlisc8266452017-04-07 12:20:30 -0600888bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600889 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Cort Stratton7df30962018-05-17 19:45:57 -0700890 const char *caller, const std::string &layout_invalid_msg_code, const std::string &layout_mismatch_msg_code,
891 bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700892 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600893 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600894 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700895
896 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
897 uint32_t layer = i + subLayers.baseArrayLayer;
898 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
899 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600900 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
901 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600902 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -0700903 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
904 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
905 "%s: Cannot use image 0x%" PRIx64
906 " (layer=%u mip=%u) with specific layout %s that doesn't match the actual current layout %s.",
907 caller, HandleToUint64(image), layer, subLayers.mipLevel, string_VkImageLayout(explicit_layout),
908 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600909 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700910 }
911 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600912 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
913 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
914 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700915 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
916 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600917 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600918 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -0600919 kVUID_Core_DrawState_InvalidImageLayout,
Petr Kraus13c98a62017-12-09 00:22:39 +0100920 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
921 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700922 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600923 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600924 if (image_state->shared_presentable) {
925 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -0700926 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
927 layout_invalid_msg_code,
928 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
929 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600930 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600931 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700932 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600933 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600934 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 -0700935 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600936 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
937 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700938 }
939 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600940 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700941}
942
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700943void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
944 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700945 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700946 if (!renderPass) return;
947
948 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
949 if (framebuffer_state) {
950 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
951 auto image_view = framebuffer_state->createInfo.pAttachments[i];
952 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
953 }
954 }
955}
Dave Houltone19e20d2018-02-02 16:32:41 -0700956
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700957bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700958 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600959 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700960 const debug_report_data *report_data = core_validation::GetReportData(device_data);
961
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600962 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600963 skip |=
964 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
965 "VUID-VkImageCreateInfo-format-00943", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600966
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600967 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600968 }
969
Dave Houlton130c0212018-01-29 13:39:56 -0700970 const char *format_string = string_VkFormat(pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700971
972 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
973 std::stringstream ss;
974 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 -0600975 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 -0600976 "VUID-VkImageCreateInfo-flags-00949", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700977 }
978
979 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
980 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
981 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
982 if (VK_SUCCESS != err) {
983 std::stringstream ss;
984 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
985 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600986 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 -0600987 "VUID-VkImageCreateInfo-format-00940", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700988 return skip;
989 }
990
991 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
992 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
993 std::stringstream ss;
994 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600995 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 -0600996 "VUID-VkImageCreateInfo-imageType-00951", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700997 }
998
999 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
1000 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
1001 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
1002 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001003 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -07001004 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001005 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 -06001006 "VUID-VkImageCreateInfo-imageType-00952", "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06001007 }
Dave Houlton130c0212018-01-29 13:39:56 -07001008 } else {
1009 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
1010 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001011 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -07001012 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
1013 "format "
1014 << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001015 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 -06001016 "VUID-VkImageCreateInfo-imageType-00953", "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06001017 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001018 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001019 }
1020
Dave Houlton130c0212018-01-29 13:39:56 -07001021 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
1022 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
1023 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
1024 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
1025 std::stringstream ss;
1026 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001027 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 -06001028 "VUID-VkImageCreateInfo-imageType-00955", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001029 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001030 }
1031
Dave Houlton130c0212018-01-29 13:39:56 -07001032 // NOTE: As of 1/30/2018 the spec VU language is as in the commented code below. I believe this is an
Dave Houltone19e20d2018-02-02 16:32:41 -07001033 // error in the spec, and have submitted Gitlab Vulkan issue #1151 to have it changed to match the
Dave Houlton130c0212018-01-29 13:39:56 -07001034 // implementation shown. DJH
1035 //
1036 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
1037 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
1038 // device_limits->maxImageDimension3D)) {
1039 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1040 std::stringstream ss;
1041 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001042 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06001043 "VUID-VkImageCreateInfo-extent-00959", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001044 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001045
Dave Houlton130c0212018-01-29 13:39:56 -07001046 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1047 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1048 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
1049 std::stringstream ss;
1050 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
1051 "maxFramebufferWidth";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001052 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 -06001053 "VUID-VkImageCreateInfo-usage-00964", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001054 }
1055
1056 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
1057 std::stringstream ss;
1058 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
1059 "maxFramebufferHeight";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001060 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 -06001061 "VUID-VkImageCreateInfo-usage-00965", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001062 }
1063
1064 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1065 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1066 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
1067
1068 // Round up to imageGranularity boundary
1069 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
1070 uint64_t ig_mask = imageGranularity - 1;
1071 total_size = (total_size + ig_mask) & ~ig_mask;
1072
1073 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001074 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 -06001075 kVUID_Core_Image_InvalidFormatLimitsViolation,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001076 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1077 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -07001078 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001079 }
1080
Dave Houlton130c0212018-01-29 13:39:56 -07001081 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001082 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1083 "VUID-VkImageCreateInfo-arrayLayers-00960",
1084 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d.", pCreateInfo->arrayLayers,
1085 format_limits.maxArrayLayers);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001086 }
1087
Dave Houlton130c0212018-01-29 13:39:56 -07001088 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001089 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06001090 "VUID-VkImageCreateInfo-samples-00967", "CreateImage samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001091 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001092 }
1093
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001094 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001095 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 -06001096 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001097 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1098 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001099 }
1100
Lenny Komowb79f04a2017-09-18 17:07:00 -06001101 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1102 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1103 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1104 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1105 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001106 skip |=
1107 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1108 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1109 "format must be block, ETC or ASTC compressed, but is %s",
1110 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001111 }
1112 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1113 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001114 skip |=
1115 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1116 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1117 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001118 }
1119 }
1120 }
1121
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001122 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001123}
1124
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001125void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001126 IMAGE_LAYOUT_NODE image_state;
1127 image_state.layout = pCreateInfo->initialLayout;
1128 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001129 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 -07001130 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001131 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1132 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001133}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001134
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001135bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001136 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001137 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +02001138 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001139 if (disabled->destroy_image) return false;
1140 bool skip = false;
1141 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06001142 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001143 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001144 }
1145 return skip;
1146}
1147
John Zulauffca05c12018-04-26 16:30:39 -06001148void PreCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001149 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001150 // Clean up memory mapping, bindings and range references for image
1151 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001152 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001153 if (mem_info) {
1154 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1155 }
1156 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001157 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001158 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001159 // Remove image from imageMap
1160 core_validation::GetImageMap(device_data)->erase(image);
1161 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1162 core_validation::GetImageSubresourceMap(device_data);
1163
1164 const auto &sub_entry = imageSubresourceMap->find(image);
1165 if (sub_entry != imageSubresourceMap->end()) {
1166 for (const auto &pair : sub_entry->second) {
1167 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1168 }
1169 imageSubresourceMap->erase(sub_entry);
1170 }
1171}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001172
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001173bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001174 bool skip = false;
1175 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1176
1177 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1178 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1179 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 -06001180 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001181 }
1182
Dave Houlton1d2022c2017-03-29 11:43:58 -06001183 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001184 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1185 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 -06001186 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001187 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001188 char const str[] = "vkCmdClearColorImage called with compressed image.";
1189 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 -06001190 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001191 }
1192
1193 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1194 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1195 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 -06001196 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001197 }
1198 return skip;
1199}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001200
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001201uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1202 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1203 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001204 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001205 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001206 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001207 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001208}
1209
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001210uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1211 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1212 uint32_t array_layer_count = range->layerCount;
1213 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1214 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001215 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001216 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001217}
1218
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001219bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001220 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1221 bool skip = false;
1222 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1223
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001224 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1225 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001226
1227 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1228 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001229 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1230 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001231 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 -06001232 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001233 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1234 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001235 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001236 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001237 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001238 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 -06001239 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001240 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1241 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001242
1243 } else {
1244 if (image_state->shared_presentable) {
1245 skip |= log_msg(
1246 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001247 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001248 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1249 string_VkImageLayout(dest_image_layout));
1250 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001251 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001252 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001253 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001254 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001255 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001256 } else {
1257 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1258 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001259 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001260 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001261 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1262 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001263 }
1264 }
1265
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001266 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1267 uint32_t level = level_index + range.baseMipLevel;
1268 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1269 uint32_t layer = layer_index + range.baseArrayLayer;
1270 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001271 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001272 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001273 if (node.layout != dest_image_layout) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001274 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001275 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001276 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001277 } else {
1278 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1279 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001280 skip |=
1281 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1282 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1283 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001284 }
1285 }
1286 }
1287 }
1288
1289 return skip;
1290}
1291
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001292void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1293 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001294 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1295 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1296 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001297
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001298 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1299 uint32_t level = level_index + range.baseMipLevel;
1300 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1301 uint32_t layer = layer_index + range.baseArrayLayer;
1302 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001303 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001304 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1305 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 -07001306 }
1307 }
1308 }
1309}
1310
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001311bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001312 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1313 bool skip = false;
1314 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001315 auto cb_node = GetCBNode(dev_data, commandBuffer);
1316 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001317 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001318 skip |=
1319 ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001320 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001321 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001322 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001323 if (GetApiVersion(dev_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001324 skip |=
1325 ValidateImageFormatFeatureFlags(dev_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1326 "VUID-vkCmdClearColorImage-image-00001", "VUID-vkCmdClearColorImage-image-00001");
Cort Stratton186b1a22018-05-01 20:18:06 -04001327 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001328 skip |= InsideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001329 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001330 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001331 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001332 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001333 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001334 }
1335 }
1336 return skip;
1337}
1338
1339// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001340void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001341 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001342 auto cb_node = GetCBNode(dev_data, commandBuffer);
1343 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001344 if (cb_node && image_state) {
1345 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001346 for (uint32_t i = 0; i < rangeCount; ++i) {
1347 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1348 }
1349 }
1350}
1351
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001352bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1353 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001354 const VkImageSubresourceRange *pRanges) {
1355 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001356 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1357
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001358 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001359 auto cb_node = GetCBNode(device_data, commandBuffer);
1360 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001361 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001362 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1363 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001364 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001365 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001366 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001367 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1368 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001369 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-00008",
1370 "VUID-vkCmdClearDepthStencilImage-image-00008");
Cort Stratton186b1a22018-05-01 20:18:06 -04001371 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001372 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001373 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001374 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001375 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001376 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001377 skip |=
1378 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001379 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001380 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1381 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001382 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001383 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1384 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001385 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 -06001386 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001387 }
1388 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001389 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001390 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001391 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 -06001392 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001393 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001394 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1395 char const str[] =
1396 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1397 "set.";
1398 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 -06001399 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001400 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001401 }
1402 return skip;
1403}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001404
1405// Returns true if [x, xoffset] and [y, yoffset] overlap
1406static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1407 bool result = false;
1408 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1409 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1410
1411 if (intersection_max > intersection_min) {
1412 result = true;
1413 }
1414 return result;
1415}
1416
Dave Houltonc991cc92018-03-06 11:08:51 -07001417// Returns true if source area of first copy region intersects dest area of second region
1418// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1419static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001420 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001421
Dave Houltonc991cc92018-03-06 11:08:51 -07001422 // Separate planes within a multiplane image cannot intersect
1423 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001424 return result;
1425 }
1426
Dave Houltonc991cc92018-03-06 11:08:51 -07001427 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1428 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1429 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001430 result = true;
1431 switch (type) {
1432 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001433 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001434 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001435 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001436 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001437 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001438 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001439 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001440 break;
1441 default:
1442 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1443 assert(false);
1444 }
1445 }
1446 return result;
1447}
1448
Dave Houltonfc1a4052017-04-27 14:32:45 -06001449// Returns non-zero if offset and extent exceed image extents
1450static const uint32_t x_bit = 1;
1451static const uint32_t y_bit = 2;
1452static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001453static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001454 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001455 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001456 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1457 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001458 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001459 }
1460 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1461 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001462 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001463 }
1464 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1465 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001466 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001467 }
1468 return result;
1469}
1470
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001471// Test if two VkExtent3D structs are equivalent
1472static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1473 bool result = true;
1474 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1475 (extent->depth != other_extent->depth)) {
1476 result = false;
1477 }
1478 return result;
1479}
1480
Dave Houltonee281a52017-12-08 13:51:02 -07001481// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1482// Destination image texel extents must be adjusted by block size for the dest validation checks
1483VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1484 VkExtent3D adjusted_extent = extent;
1485 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1486 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1487 adjusted_extent.width /= block_size.width;
1488 adjusted_extent.height /= block_size.height;
1489 adjusted_extent.depth /= block_size.depth;
1490 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1491 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1492 adjusted_extent.width *= block_size.width;
1493 adjusted_extent.height *= block_size.height;
1494 adjusted_extent.depth *= block_size.depth;
1495 }
1496 return adjusted_extent;
1497}
1498
Dave Houlton6f9059e2017-05-02 17:15:13 -06001499// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001500static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1501 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001502
1503 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001504 if (mip >= img->createInfo.mipLevels) {
1505 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001506 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001507
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001508 // 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 -06001509 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001510 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1511 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1512 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001513
Dave Houlton6f9059e2017-05-02 17:15:13 -06001514 // Image arrays have an effective z extent that isn't diminished by mip level
1515 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001516 extent.depth = img->createInfo.arrayLayers;
1517 }
1518
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001519 return extent;
1520}
1521
1522// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001523static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001524 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1525}
1526
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001527// Test if the extent argument has any dimensions set to 0.
1528static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1529 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1530}
1531
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001532// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1533static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1534 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1535 VkExtent3D granularity = {0, 0, 0};
1536 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1537 if (pPool) {
1538 granularity =
1539 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001540 if (FormatIsCompressed(img->createInfo.format)) {
1541 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001542 granularity.width *= block_size.width;
1543 granularity.height *= block_size.height;
1544 }
1545 }
1546 return granularity;
1547}
1548
1549// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1550static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1551 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001552 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1553 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001554 valid = false;
1555 }
1556 return valid;
1557}
1558
1559// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1560static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001561 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001562 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001563 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1564 bool skip = false;
1565 VkExtent3D offset_extent = {};
1566 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1567 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1568 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001569 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001570 // 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 -07001571 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001572 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 -04001573 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001574 "%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 "
1575 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001576 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001577 }
1578 } else {
1579 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1580 // integer multiples of the image transfer granularity.
1581 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001582 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 -04001583 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001584 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1585 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001586 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1587 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001588 }
1589 }
1590 return skip;
1591}
1592
1593// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1594static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1595 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001596 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001597 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001598 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1599 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001600 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001601 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1602 // subresource extent.
1603 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001604 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 -04001605 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001606 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1607 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1608 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1609 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001610 }
1611 } else {
1612 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1613 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1614 // subresource extent dimensions.
1615 VkExtent3D offset_extent_sum = {};
1616 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1617 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1618 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001619 bool x_ok = true;
1620 bool y_ok = true;
1621 bool z_ok = true;
1622 switch (image_type) {
1623 case VK_IMAGE_TYPE_3D:
1624 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1625 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001626 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001627 case VK_IMAGE_TYPE_2D:
1628 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1629 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001630 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001631 case VK_IMAGE_TYPE_1D:
1632 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1633 (subresource_extent->width == offset_extent_sum.width));
1634 break;
1635 default:
1636 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1637 assert(false);
1638 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001639 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001640 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 -04001641 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001642 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1643 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1644 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1645 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1646 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1647 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001648 }
1649 }
1650 return skip;
1651}
1652
Cort Strattonff1542a2018-05-27 10:49:28 -07001653bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
1654 const uint32_t i, const char *function, const char *member, const std::string &vuid) {
1655 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1656 bool skip = false;
1657 if (mip_level >= img->createInfo.mipLevels) {
1658 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1659 HandleToUint64(cb_node->commandBuffer), vuid,
1660 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
1661 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
1662 }
1663 return skip;
1664}
1665
1666bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
1667 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
1668 const char *member, const std::string &vuid) {
1669 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1670 bool skip = false;
1671 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
1672 (base_layer + layer_count) > img->createInfo.arrayLayers) {
1673 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1674 HandleToUint64(cb_node->commandBuffer), vuid,
1675 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
1676 "%u, but provided image %" PRIx64 " has %u array layers.",
1677 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
1678 }
1679 return skip;
1680}
1681
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001682// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001683bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1684 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Dave Houltone0969282018-05-23 15:54:31 -06001685 const uint32_t i, const char *function, const std::string &vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001686 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04001687 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1688 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
1689 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1690 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1691 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001692 return skip;
1693}
1694
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001695// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001696bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001697 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1698 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001699 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001700 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001701 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06001702 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
1703 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001704 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001705 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001706 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06001707 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001708
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001709 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001710 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06001711 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
1712 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07001713 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001714 const VkExtent3D dest_effective_extent =
1715 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001716 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001717 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06001718 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001719 return skip;
1720}
1721
Dave Houlton6f9059e2017-05-02 17:15:13 -06001722// Validate contents of a VkImageCopy struct
1723bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1724 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1725 bool skip = false;
1726
1727 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001728 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001729
1730 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001731 const VkExtent3D src_copy_extent = region.extent;
1732 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001733 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1734
Dave Houlton6f9059e2017-05-02 17:15:13 -06001735 bool slice_override = false;
1736 uint32_t depth_slices = 0;
1737
1738 // Special case for copying between a 1D/2D array and a 3D image
1739 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1740 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001741 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001742 slice_override = (depth_slices != 1);
1743 } 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 -07001744 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001745 slice_override = (depth_slices != 1);
1746 }
1747
1748 // Do all checks on source image
1749 //
1750 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001751 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1752 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 -06001753 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07001754 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001755 "be 0 and 1, respectively.",
1756 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001757 }
1758 }
1759
Dave Houlton533be9f2018-03-26 17:08:30 -06001760 // VUID-VkImageCopy-srcImage-01785
1761 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1762 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 -06001763 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06001764 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001765 "these must be 0 and 1, respectively.",
1766 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001767 }
1768
Dave Houlton533be9f2018-03-26 17:08:30 -06001769 // VUID-VkImageCopy-srcImage-01787
1770 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1771 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 -06001772 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001773 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
1774 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06001775 }
1776
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001777 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001778 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001779 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001780 skip |=
1781 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001782 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001783 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001784 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1785 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001786 }
1787 }
1788 } else { // Pre maint 1
1789 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001790 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001791 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 -06001792 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01001793 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1794 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001795 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1796 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001797 }
1798 }
1799 }
1800
Dave Houltonc991cc92018-03-06 11:08:51 -07001801 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1802 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
1803 if (FormatIsCompressed(src_state->createInfo.format) ||
1804 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001805 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001806 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001807 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1808 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1809 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001810 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001811 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 -07001812 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001813 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001814 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001815 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001816 }
1817
Dave Houlton94a00372017-12-14 15:08:47 -07001818 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001819 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1820 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001821 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001822 skip |=
1823 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001824 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001825 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001826 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001827 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001828 }
1829
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001830 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001831 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1832 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001833 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001834 skip |=
1835 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001836 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001837 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001838 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001839 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001840 }
1841
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001842 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001843 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1844 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001845 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001846 skip |=
1847 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001848 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001849 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001850 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001851 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001852 }
1853 } // Compressed
1854
1855 // Do all checks on dest image
1856 //
1857 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001858 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001859 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 -06001860 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001861 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001862 "these must be 0 and 1, respectively.",
1863 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001864 }
1865 }
1866
Dave Houlton533be9f2018-03-26 17:08:30 -06001867 // VUID-VkImageCopy-dstImage-01786
1868 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
1869 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 -06001870 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06001871 "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 -06001872 "and 1, respectively.",
1873 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06001874 }
1875
1876 // VUID-VkImageCopy-dstImage-01788
1877 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
1878 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 -06001879 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001880 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
1881 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001882 }
1883
1884 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001885 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001886 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 -06001887 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001888 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001889 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1890 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001891 }
1892 }
1893 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001894 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001895 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001896 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001897 skip |=
1898 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001899 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001900 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001901 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1902 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001903 }
1904 }
1905 } else { // Pre maint 1
1906 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001907 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001908 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 -06001909 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01001910 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1911 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001912 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1913 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001914 }
1915 }
1916 }
1917
Dave Houltonc991cc92018-03-06 11:08:51 -07001918 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1919 if (FormatIsCompressed(dst_state->createInfo.format) ||
1920 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001921 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001922
1923 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001924 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1925 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1926 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001927 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06001928 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 -07001929 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001930 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001931 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001932 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001933 }
1934
Dave Houlton94a00372017-12-14 15:08:47 -07001935 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001936 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1937 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001938 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07001939 skip |=
1940 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001941 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001942 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001943 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001944 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001945 }
1946
Dave Houltonee281a52017-12-08 13:51:02 -07001947 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1948 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1949 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001950 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07001951 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 -07001952 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001953 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1954 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07001955 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001956 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001957 }
1958
Dave Houltonee281a52017-12-08 13:51:02 -07001959 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1960 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1961 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001962 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07001963 skip |=
1964 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001965 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001966 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001967 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001968 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001969 }
1970 } // Compressed
1971 }
1972 return skip;
1973}
1974
Dave Houltonc991cc92018-03-06 11:08:51 -07001975// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
1976bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
1977 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
1978 bool skip = false;
1979 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
1980
1981 // Neither image is multiplane
1982 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
1983 // If neither image is multi-plane the aspectMask member of src and dst must match
1984 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1985 std::stringstream ss;
1986 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
1987 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
1988 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 -06001989 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07001990 }
1991 } else {
1992 // Source image multiplane checks
1993 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
1994 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
1995 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
1996 std::stringstream ss;
1997 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
1998 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 -06001999 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002000 }
2001 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2002 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2003 std::stringstream ss;
2004 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2005 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 -06002006 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002007 }
2008 // Single-plane to multi-plane
2009 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2010 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2011 std::stringstream ss;
2012 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2013 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 -06002014 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002015 }
2016
2017 // Dest image multiplane checks
2018 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2019 aspect = region.dstSubresource.aspectMask;
2020 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2021 std::stringstream ss;
2022 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2023 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 -06002024 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002025 }
2026 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2027 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2028 std::stringstream ss;
2029 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2030 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 -06002031 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002032 }
2033 // Multi-plane to single-plane
2034 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2035 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2036 std::stringstream ss;
2037 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2038 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 -06002039 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002040 }
2041 }
2042
2043 return skip;
2044}
2045
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002046bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002047 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2048 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002049 bool skip = false;
2050 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002051 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
2052
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002053 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2054
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002055 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002056 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002057
2058 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2059 VkExtent3D src_copy_extent = region.extent;
2060 VkExtent3D dst_copy_extent =
2061 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2062
Dave Houlton6f9059e2017-05-02 17:15:13 -06002063 bool slice_override = false;
2064 uint32_t depth_slices = 0;
2065
2066 // Special case for copying between a 1D/2D array and a 3D image
2067 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2068 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2069 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002070 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002071 slice_override = (depth_slices != 1);
2072 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2073 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002074 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002075 slice_override = (depth_slices != 1);
2076 }
2077
Cort Strattond619a302018-05-17 19:46:32 -07002078 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2079 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002080 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2081 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2082 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2083 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2084 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2085 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2086 "VUID-vkCmdCopyImage-srcSubresource-01698");
2087 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2088 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2089 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002090
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002091 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002092 // No chance of mismatch if we're overriding depth slice count
2093 if (!slice_override) {
2094 // The number of depth slices in srcSubresource and dstSubresource must match
2095 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2096 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002097 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2098 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002099 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002100 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2101 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002102 if (src_slices != dst_slices) {
2103 std::stringstream ss;
2104 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
2105 << "] do not match";
2106 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 -06002107 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002108 }
2109 }
2110 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002111 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002112 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002113 std::stringstream ss;
2114 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
2115 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002116 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 -06002117 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002118 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002119 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002120
Dave Houltonc991cc92018-03-06 11:08:51 -07002121 // Do multiplane-specific checks, if extension enabled
2122 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2123 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2124 }
2125
Dave Houltonf5217612018-02-02 16:18:52 -07002126 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2127 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2128 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2129 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
2130 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 -06002131 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002132 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002133 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002134
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002135 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002136 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002137 std::stringstream ss;
2138 ss << "vkCmdCopyImage: pRegion[" << i
2139 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2140 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 -06002141 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002142 }
2143
2144 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002145 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002146 std::stringstream ss;
2147 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2148 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 -06002149 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002150 }
2151
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002152 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2153 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2154 // 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 -07002155 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2156 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002157 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002158 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
2159 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2160 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2161 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002162 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-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002164 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002165
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002166 // 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 -07002167 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2168 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002169 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002170 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2171 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2172 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2173 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002174 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 -06002175 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002176 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002177 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002178
Dave Houltonfc1a4052017-04-27 14:32:45 -06002179 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002180 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2181 if (slice_override) src_copy_extent.depth = depth_slices;
2182 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002183 if (extent_check & x_bit) {
2184 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 -06002185 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002186 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002187 "width [%1d].",
2188 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002189 }
2190
2191 if (extent_check & y_bit) {
2192 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 -06002193 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002194 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002195 "height [%1d].",
2196 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002197 }
2198 if (extent_check & z_bit) {
2199 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 -06002200 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002201 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002202 "depth [%1d].",
2203 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002204 }
2205
Dave Houltonee281a52017-12-08 13:51:02 -07002206 // Adjust dest extent if necessary
2207 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2208 if (slice_override) dst_copy_extent.depth = depth_slices;
2209
2210 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002211 if (extent_check & x_bit) {
2212 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002213 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002214 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002215 "width [%1d].",
2216 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002217 }
2218 if (extent_check & y_bit) {
2219 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 -06002220 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002221 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002222 "height [%1d].",
2223 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002224 }
2225 if (extent_check & z_bit) {
2226 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 -06002227 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002228 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002229 "depth [%1d].",
2230 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002231 }
2232
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002233 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2234 // must not overlap in memory
2235 if (src_image_state->image == dst_image_state->image) {
2236 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002237 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2238 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002239 std::stringstream ss;
2240 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2241 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 -06002242 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002243 }
2244 }
2245 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002246 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002247
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002248 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2249 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2250 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002251 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002252 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2253 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002254 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 -06002255 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002256 }
2257 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002258 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2259 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002260 if (srcSize != destSize) {
2261 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2262 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 -06002263 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002264 }
2265 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002266
Dave Houlton33c22b72017-02-28 13:16:02 -07002267 // Source and dest image sample counts must match
2268 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2269 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
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-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002272 }
2273
Dave Houltond8ed0212018-05-16 17:18:24 -06002274 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2275 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002276 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002277 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2278 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2279 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2280 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002281 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002282 skip |=
2283 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2284 "VUID-vkCmdCopyImage-srcImage-00125", "VUID-vkCmdCopyImage-srcImage-00125");
2285 skip |=
2286 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2287 "VUID-vkCmdCopyImage-dstImage-00130", "VUID-vkCmdCopyImage-dstImage-00130");
Cort Stratton186b1a22018-05-01 20:18:06 -04002288 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002289 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002290 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2291 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002292 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002293 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002294 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07002295 const std::string invalid_src_layout_vuid =
2296 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2297 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2298 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2299 const std::string invalid_dst_layout_vuid =
2300 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2301 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2302 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002303 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002304 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002305 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2306 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002307 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002308 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2309 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002310 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2311 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002312 }
2313
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002314 return skip;
2315}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002316
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002317void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002318 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2319 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2320 // Make sure that all image slices are updated to correct layout
2321 for (uint32_t i = 0; i < region_count; ++i) {
2322 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2323 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2324 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002325 // Update bindings between images and cmd buffer
2326 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2327 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002328}
2329
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002330// Returns true if sub_rect is entirely contained within rect
2331static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2332 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2333 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2334 return false;
2335 return true;
2336}
2337
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002338bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2339 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002340 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002341 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2342
2343 bool skip = false;
2344 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002345 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002346 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002347 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002348 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002349 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002350 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2351 // 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 -07002352 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2353 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002354 skip |= log_msg(
2355 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002356 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002357 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2358 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2359 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002360 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002361 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002362 }
2363
2364 // Validate that attachment is in reference list of active subpass
2365 if (cb_node->activeRenderPass) {
2366 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2367 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002368 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002369
2370 for (uint32_t i = 0; i < attachmentCount; i++) {
2371 auto clear_desc = &pAttachments[i];
2372 VkImageView image_view = VK_NULL_HANDLE;
2373
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002374 if (0 == clear_desc->aspectMask) {
2375 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 -06002376 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002377 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2378 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002379 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002380 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002381 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002382 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 -06002383 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-00015",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002384 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d.",
2385 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002386 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2387 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002388 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06002389 kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002390 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2391 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002392 } else {
2393 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002394 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002395 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002396 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2397 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2398 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002399 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002400 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 -06002401 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002402 }
2403 } else { // Must be depth and/or stencil
2404 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2405 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002406 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002407 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 -06002408 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002409 }
2410 if (!subpass_desc->pDepthStencilAttachment ||
2411 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2412 skip |= log_msg(
2413 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002414 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002415 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002416 } else {
2417 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2418 }
2419 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002420 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002421 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002422 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002423 // The rectangular region specified by a given element of pRects must be contained within the render area of
2424 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002425 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2426 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2427 skip |=
2428 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002429 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002430 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002431 "the current render pass instance.",
2432 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002433 }
2434 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002435 const auto local_rect =
2436 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002437 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002438 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002439 return log_msg(
2440 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002441 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002442 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002443 "the current render pass instance.",
2444 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002445 }
2446 return false;
2447 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002448 }
2449 // The layers specified by a given element of pRects must be contained within every attachment that
2450 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002451 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002452 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2453 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002454 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 -06002455 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00017",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002456 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002457 "of pAttachment[%d].",
2458 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002459 }
2460 }
2461 }
2462 }
2463 }
2464 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002465}
2466
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002467bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Cort Stratton7df30962018-05-17 19:45:57 -07002468 VkImageLayout src_image_layout, IMAGE_STATE *dst_image_state, VkImageLayout dst_image_layout,
2469 uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002470 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002471 bool skip = false;
2472 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002473 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2474 "VUID-vkCmdResolveImage-srcImage-00256");
2475 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2476 "VUID-vkCmdResolveImage-dstImage-00258");
2477 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2478 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002479 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002480 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002481 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002482 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00264",
2483 "VUID-vkCmdResolveImage-dstImage-00265");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002484
Cort Stratton7df30962018-05-17 19:45:57 -07002485 bool hit_error = false;
2486 const std::string invalid_src_layout_vuid =
2487 (src_image_state->shared_presentable &&
2488 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2489 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2490 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2491 const std::string invalid_dst_layout_vuid =
2492 (dst_image_state->shared_presentable &&
2493 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2494 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2495 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002496 // For each region, the number of layers in the image subresource should not be zero
2497 // For each region, src and dest image aspect must be color only
2498 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002499 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2500 "srcSubresource", i);
2501 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2502 "dstSubresource", i);
Cort Stratton7df30962018-05-17 19:45:57 -07002503 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, src_image_layout,
2504 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2505 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
2506 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dst_image_layout,
2507 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2508 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002509 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2510 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2511 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2512 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2513 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2514 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2515 "VUID-vkCmdResolveImage-srcSubresource-01711");
2516 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2517 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2518 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002519
2520 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002521 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2522 skip |= log_msg(
2523 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002524 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002525 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002526 }
Cort Stratton7df30962018-05-17 19:45:57 -07002527 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002528 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2529 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2530 char const str[] =
2531 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2532 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 -06002533 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002534 }
2535 }
2536
2537 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2538 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002539 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 -06002540 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002541 }
2542 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2543 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002544 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 -06002545 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002546 }
2547 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2548 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2549 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002550 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002551 }
2552 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2553 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2554 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002555 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002556 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002557 } else {
2558 assert(0);
2559 }
2560 return skip;
2561}
2562
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002563void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2564 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002565 // Update bindings between images and cmd buffer
2566 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2567 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002568}
2569
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002570bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002571 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2572 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002573 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2574
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002575 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002576 if (cb_node) {
2577 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2578 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002579 if (cb_node && src_image_state && dst_image_state) {
2580 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002581 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002582 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002583 "VUID-vkCmdBlitImage-dstImage-00234");
2584 skip |=
2585 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2586 skip |=
2587 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
2588 skip |=
2589 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2590 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2591 skip |=
2592 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2593 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2594 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
2595 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002596 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002597 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002598 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002599 "VUID-vkCmdBlitImage-srcImage-00218", "VUID-vkCmdBlitImage-srcImage-00218");
Cort Stratton186b1a22018-05-01 20:18:06 -04002600 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002601 "VUID-vkCmdBlitImage-dstImage-00223", "VUID-vkCmdBlitImage-dstImage-00223");
Cort Stratton186b1a22018-05-01 20:18:06 -04002602
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002603 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002604
Dave Houlton33c2d252017-06-09 17:08:32 -06002605 VkFormat src_format = src_image_state->createInfo.format;
2606 VkFormat dst_format = dst_image_state->createInfo.format;
2607 VkImageType src_type = src_image_state->createInfo.imageType;
2608 VkImageType dst_type = dst_image_state->createInfo.imageType;
2609
Cort Stratton186b1a22018-05-01 20:18:06 -04002610 if (VK_FILTER_LINEAR == filter) {
2611 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002612 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-00235",
2613 "VUID-vkCmdBlitImage-filter-00235");
Cort Stratton186b1a22018-05-01 20:18:06 -04002614 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002615 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
2616 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
2617 "VUID-vkCmdBlitImage-filter-00236", "VUID-vkCmdBlitImage-filter-00236");
Dave Houlton33c2d252017-06-09 17:08:32 -06002618 }
2619
2620 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2621 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002622 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002623 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002624 }
2625
Dave Houlton33c2d252017-06-09 17:08:32 -06002626 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2627 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2628 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 -06002629 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002630 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002631 }
2632
2633 // Validate consistency for unsigned formats
2634 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2635 std::stringstream ss;
2636 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2637 << "the other one must also have unsigned integer format. "
2638 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2639 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 -06002640 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002641 }
2642
2643 // Validate consistency for signed formats
2644 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2645 std::stringstream ss;
2646 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2647 << "the other one must also have signed integer format. "
2648 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2649 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 -06002650 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002651 }
2652
2653 // Validate filter for Depth/Stencil formats
2654 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2655 std::stringstream ss;
2656 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2657 << "then filter must be VK_FILTER_NEAREST.";
2658 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 -06002659 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002660 }
2661
2662 // Validate aspect bits and formats for depth/stencil images
2663 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2664 if (src_format != dst_format) {
2665 std::stringstream ss;
2666 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2667 << "stencil, the other one must have exactly the same format. "
2668 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2669 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06002670 skip |=
2671 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2672 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002673 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002674 } // Depth or Stencil
2675
2676 // Do per-region checks
Cort Stratton7df30962018-05-17 19:45:57 -07002677 const std::string invalid_src_layout_vuid =
2678 (src_image_state->shared_presentable &&
2679 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2680 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
2681 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
2682 const std::string invalid_dst_layout_vuid =
2683 (dst_image_state->shared_presentable &&
2684 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2685 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
2686 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002687 for (uint32_t i = 0; i < region_count; i++) {
2688 const VkImageBlit rgn = regions[i];
2689 bool hit_error = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06002690 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002691 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
2692 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Dave Houltond8ed0212018-05-16 17:18:24 -06002693 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002694 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
2695 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07002696 skip |=
2697 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
2698 skip |=
2699 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002700 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
2701 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
2702 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
2703 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
2704 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
2705 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
2706 "VUID-vkCmdBlitImage-srcSubresource-01707");
2707 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
2708 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
2709 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002710 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002711 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2712 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002713 std::stringstream ss;
2714 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06002715 skip |=
2716 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2717 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002718 }
Dave Houlton48989f32017-05-26 15:01:46 -06002719 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2720 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002721 std::stringstream ss;
2722 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06002723 skip |=
2724 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2725 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002726 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002727
2728 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002729 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002730 skip |=
2731 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002732 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002733 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002734 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002735
Dave Houlton48989f32017-05-26 15:01:46 -06002736 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002737 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 -06002738 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002739 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002740 }
Dave Houlton48989f32017-05-26 15:01:46 -06002741
Dave Houlton33c2d252017-06-09 17:08:32 -06002742 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2743 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002744 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Dave Houlton33c2d252017-06-09 17:08:32 -06002745 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002746 "image format %s.",
2747 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002748 }
2749
2750 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2751 skip |= log_msg(
2752 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002753 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002754 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
2755 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002756 }
2757
Dave Houlton48989f32017-05-26 15:01:46 -06002758 // Validate source image offsets
2759 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002760 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002761 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2762 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 -06002763 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
Dave Houlton48989f32017-05-26 15:01:46 -06002764 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002765 "of (%1d, %1d). These must be (0, 1).",
2766 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002767 }
2768 }
2769
Dave Houlton33c2d252017-06-09 17:08:32 -06002770 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002771 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2772 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 -06002773 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Dave Houlton48989f32017-05-26 15:01:46 -06002774 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002775 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
2776 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002777 }
2778 }
2779
Dave Houlton33c2d252017-06-09 17:08:32 -06002780 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002781 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2782 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002783 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002784 skip |=
2785 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002786 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002787 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
2788 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002789 }
2790 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2791 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002792 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002793 skip |= log_msg(
2794 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002795 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002796 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
2797 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002798 }
2799 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2800 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002801 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002802 skip |=
2803 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002804 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002805 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
2806 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002807 }
Cort Strattonff1542a2018-05-27 10:49:28 -07002808 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002809 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 -06002810 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002811 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06002812 }
Dave Houlton48989f32017-05-26 15:01:46 -06002813
2814 // Validate dest image offsets
2815 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002816 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002817 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2818 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 -06002819 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
Dave Houlton48989f32017-05-26 15:01:46 -06002820 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002821 "(%1d, %1d). These must be (0, 1).",
2822 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002823 }
2824 }
2825
Dave Houlton33c2d252017-06-09 17:08:32 -06002826 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002827 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002829 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Dave Houlton48989f32017-05-26 15:01:46 -06002830 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002831 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
2832 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002833 }
2834 }
2835
Dave Houlton33c2d252017-06-09 17:08:32 -06002836 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002837 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2838 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002839 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002840 skip |=
2841 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002842 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002843 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
2844 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002845 }
2846 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2847 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002848 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002849 skip |= log_msg(
2850 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002851 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002852 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
2853 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002854 }
2855 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2856 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002857 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002858 skip |=
2859 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002860 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002861 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
2862 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002863 }
Cort Strattonff1542a2018-05-27 10:49:28 -07002864 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002865 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 -06002866 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002867 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002868 }
2869
Dave Houlton33c2d252017-06-09 17:08:32 -06002870 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2871 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2872 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2873 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 -06002874 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
Dave Houlton33c2d252017-06-09 17:08:32 -06002875 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002876 "layerCount other than 1.",
2877 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002878 }
2879 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002880 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002881 } else {
2882 assert(0);
2883 }
2884 return skip;
2885}
2886
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002887void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002888 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2889 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2890 // Make sure that all image slices are updated to correct layout
2891 for (uint32_t i = 0; i < region_count; ++i) {
2892 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2893 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2894 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002895 // Update bindings between images and cmd buffer
2896 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2897 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002898}
2899
Tony Barbourdf013b92017-01-25 12:53:48 -07002900// This validates that the initial layout specified in the command buffer for
2901// the IMAGE is the same
2902// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002903bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002904 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2905 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002906 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002907 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002908 for (auto cb_image_data : pCB->imageLayoutMap) {
2909 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002910
Dave Houltonb3f4b282018-02-22 16:25:16 -07002911 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2912 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002913 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2914 // TODO: Set memory invalid which is in mem_tracker currently
2915 } else if (imageLayout != cb_image_data.second.initialLayout) {
2916 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002917 skip |= log_msg(
2918 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002919 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002920 "Cannot submit cmd buffer using image (0x%" PRIx64
2921 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2922 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2923 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2924 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002925 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002926 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 -06002927 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002928 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002929 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2930 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002931 }
2932 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002933 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002934 }
2935 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002936 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002937}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002938
Tony Barbourdf013b92017-01-25 12:53:48 -07002939void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2940 for (auto cb_image_data : pCB->imageLayoutMap) {
2941 VkImageLayout imageLayout;
2942 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2943 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2944 }
2945}
2946
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002947// Print readable FlagBits in FlagMask
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002948static std::string StringVkAccessFlags(VkAccessFlags accessMask) {
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002949 std::string result;
2950 std::string separator;
2951
2952 if (accessMask == 0) {
2953 result = "[None]";
2954 } else {
2955 result = "[";
2956 for (auto i = 0; i < 32; i++) {
2957 if (accessMask & (1 << i)) {
2958 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2959 separator = " | ";
2960 }
2961 }
2962 result = result + "]";
2963 }
2964 return result;
2965}
2966
Dave Houlton12befb92018-06-26 17:16:46 -06002967#if 0 // This fxn seems vestigial, not called anywhere. All VkAccessFlagBits VUIDs are implicit & being checked by parameter
2968 // validation ToBeRemoved (disabled 6/18)
2969
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002970// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2971// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002972// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002973static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2974 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2975 const char *type) {
2976 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2977 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002978
2979 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2980 if (accessMask & ~(required_bit | optional_bits)) {
2981 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002982 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 -06002983 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002984 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002985 StringVkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002986 }
2987 } else {
2988 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002989 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 -06002990 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002991 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
2992 "has previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002993 type, accessMask, StringVkAccessFlags(accessMask).c_str(), optional_bits,
2994 StringVkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002995 } else {
2996 std::string opt_bits;
2997 if (optional_bits != 0) {
2998 std::stringstream ss;
2999 ss << optional_bits;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003000 opt_bits = "and may have optional bits " + ss.str() + ' ' + StringVkAccessFlags(optional_bits);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003001 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003002 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 -06003003 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003004 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
3005 "previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003006 type, accessMask, StringVkAccessFlags(accessMask).c_str(), required_bit,
3007 StringVkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003008 }
3009 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003010 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003011}
Dave Houlton12befb92018-06-26 17:16:46 -06003012#endif
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003013
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003014// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003015// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3016// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003017bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003018 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
3019 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003020 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3021 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3022 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3023 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003024 skip |=
3025 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3026 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3027 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003028 }
3029 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003030 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3031 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003032 skip |=
3033 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3034 "VUID-VkRenderPassCreateInfo-pAttachments-01566",
3035 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003036 }
3037 }
3038
3039 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3040 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003041 skip |=
3042 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3043 "VUID-VkRenderPassCreateInfo-pAttachments-01567",
3044 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003045 }
3046 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003047 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003048}
3049
John Zulauf7ec577a2018-06-08 17:00:13 -06003050bool ValidateLayouts(const core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003051 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003052 bool skip = false;
3053
Jason Ekstranda1906302017-12-03 20:16:32 -08003054 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3055 VkFormat format = pCreateInfo->pAttachments[i].format;
3056 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3057 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3058 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003059 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 -06003060 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003061 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3062 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3063 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3064 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003065 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003066 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003067 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 -06003068 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003069 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3070 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3071 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3072 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003073 }
3074 }
3075 }
3076
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003077 // Track when we're observing the first use of an attachment
3078 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3079 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
3080 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003081
3082 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3083 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3084 auto attach_index = subpass.pInputAttachments[j].attachment;
3085 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3086
3087 switch (subpass.pInputAttachments[j].layout) {
3088 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3089 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3090 // These are ideal.
3091 break;
3092
3093 case VK_IMAGE_LAYOUT_GENERAL:
3094 // May not be optimal. TODO: reconsider this warning based on other constraints.
3095 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003096 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003097 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3098 break;
3099
3100 default:
3101 // No other layouts are acceptable
3102 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 -06003103 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003104 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3105 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3106 }
3107
Cort Stratton7547f772017-05-04 15:18:52 -07003108 if (attach_first_use[attach_index]) {
3109 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
3110 pCreateInfo->pAttachments[attach_index]);
3111
3112 bool used_as_depth =
3113 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3114 bool used_as_color = false;
3115 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3116 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3117 }
3118 if (!used_as_depth && !used_as_color &&
3119 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3120 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003121 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06003122 "VUID-VkSubpassDescription-loadOp-00846",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003123 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3124 attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003125 }
3126 }
3127 attach_first_use[attach_index] = false;
3128 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003129 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3130 auto attach_index = subpass.pColorAttachments[j].attachment;
3131 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3132
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003133 // TODO: Need a way to validate shared presentable images here, currently just allowing
3134 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3135 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003136 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003137 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003138 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003139 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3140 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003141 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003142
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003143 case VK_IMAGE_LAYOUT_GENERAL:
3144 // May not be optimal; TODO: reconsider this warning based on other constraints?
3145 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003146 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003147 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3148 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003149
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003150 default:
3151 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 -06003152 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003153 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3154 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003155 }
3156
3157 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003158 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
3159 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003160 }
3161 attach_first_use[attach_index] = false;
3162 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003163
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003164 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3165 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003166 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3167 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3168 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003169 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003170
Dave Houltona9df0ce2018-02-07 10:51:23 -07003171 case VK_IMAGE_LAYOUT_GENERAL:
3172 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3173 // doing a bunch of transitions.
3174 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003175 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003176 "GENERAL layout for depth attachment may not give optimal performance.");
3177 break;
3178
3179 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3180 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3181 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3182 break;
3183 } else {
3184 // Intentionally fall through to generic error message
3185 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003186 // fall through
Dave Houltona9df0ce2018-02-07 10:51:23 -07003187 default:
3188 // No other layouts are acceptable
3189 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 -06003190 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003191 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3192 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3193 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003194 }
3195
3196 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3197 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003198 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
3199 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003200 }
3201 attach_first_use[attach_index] = false;
3202 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003203 }
3204 return skip;
3205}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003206
3207// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003208bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3209 VkDeviceSize offset, VkDeviceSize end_offset) {
3210 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3211 bool skip = false;
3212 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3213 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003214 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3215 for (auto image_handle : mem_info->bound_images) {
3216 auto img_it = mem_info->bound_ranges.find(image_handle);
3217 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003218 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003219 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003220 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003221 for (auto layout : layouts) {
3222 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003223 skip |=
3224 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 -06003225 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003226 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3227 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003228 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003229 }
3230 }
3231 }
3232 }
3233 }
3234 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003235 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003236}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003237
3238// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3239// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003240static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3241 VulkanObjectType obj_type, std::string msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003242 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003243
3244 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003245 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003246 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003247 if (strict) {
3248 correct_usage = ((actual & desired) == desired);
3249 } else {
3250 correct_usage = ((actual & desired) != 0);
3251 }
3252 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003253 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003254 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003255 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003256 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 -06003257 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003258 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3259 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003260 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003261 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003262 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 -06003263 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3264 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003265 }
3266 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003267 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003268}
3269
3270// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3271// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003272bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003273 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003274 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3275 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003276}
3277
Cort Stratton186b1a22018-05-01 20:18:06 -04003278bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Dave Houltone0969282018-05-23 15:54:31 -06003279 char const *func_name, const std::string &linear_vuid, const std::string &optimal_vuid) {
Cort Stratton186b1a22018-05-01 20:18:06 -04003280 VkFormatProperties format_properties = GetFormatProperties(dev_data, image_state->createInfo.format);
3281 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3282 bool skip = false;
3283 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3284 if ((format_properties.linearTilingFeatures & desired) != desired) {
3285 skip |=
3286 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3287 HandleToUint64(image_state->image), linear_vuid,
3288 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3289 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3290 }
3291 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3292 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3293 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3294 HandleToUint64(image_state->image), optimal_vuid,
3295 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3296 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3297 HandleToUint64(image_state->image));
3298 }
3299 }
3300 return skip;
3301}
3302
Cort Strattond619a302018-05-17 19:46:32 -07003303bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3304 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3305 uint32_t i) {
3306 bool skip = false;
3307 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3308 // layerCount must not be zero
3309 if (subresource_layers->layerCount == 0) {
3310 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3311 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3312 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3313 }
3314 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3315 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3316 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3317 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3318 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3319 }
3320 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3321 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3322 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3323 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3324 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3325 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3326 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3327 func_name, i, member);
3328 }
3329 return skip;
3330}
3331
Mark Lobodzinski96210742017-02-09 10:33:46 -07003332// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3333// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003334bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003335 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003336 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3337 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003338}
3339
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003340bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3341 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3342 bool skip = false;
3343 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3344
3345 const VkDeviceSize &range = pCreateInfo->range;
3346 if (range != VK_WHOLE_SIZE) {
3347 // Range must be greater than 0
3348 if (range <= 0) {
3349 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3350 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3351 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3352 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3353 range);
3354 }
3355 // Range must be a multiple of the element size of format
3356 const size_t format_size = FormatSize(pCreateInfo->format);
3357 if (range % format_size != 0) {
3358 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3359 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3360 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3361 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3362 "(" PRINTF_SIZE_T_SPECIFIER ").",
3363 range, format_size);
3364 }
3365 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3366 if (range / format_size > device_limits->maxTexelBufferElements) {
3367 skip |=
3368 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3369 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3370 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3371 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3372 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3373 range, format_size, device_limits->maxTexelBufferElements);
3374 }
3375 // The sum of range and offset must be less than or equal to the size of buffer
3376 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3377 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3378 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3379 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3380 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3381 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3382 range, pCreateInfo->offset, buffer_state->createInfo.size);
3383 }
3384 }
3385 return skip;
3386}
3387
Shannon McPherson265383a2018-06-21 15:37:52 -06003388bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3389 const VkBufferViewCreateInfo *pCreateInfo) {
3390 bool skip = false;
3391 const debug_report_data *report_data = GetReportData(device_data);
3392 const VkFormatProperties format_properties = GetFormatProperties(device_data, pCreateInfo->format);
3393 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3394 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3395 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3396 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3397 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3398 "be supported for uniform texel buffers");
3399 }
3400 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3401 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3402 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3403 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3404 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3405 "be supported for storage texel buffers");
3406 }
3407 return skip;
3408}
3409
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003410bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003411 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003412 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3413
Dave Houltond8ed0212018-05-16 17:18:24 -06003414 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003415
3416 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003417 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 -06003418 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003419 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003420 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003421 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003422
3423 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003424 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 -06003425 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003426 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003427 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003428 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003429
3430 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003431 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 -06003432 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003433 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003434 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003435 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003436 return skip;
3437}
3438
3439void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3440 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3441 GetBufferMap(device_data)
3442 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3443}
3444
Shannon McPhersona84241a2018-06-18 15:34:46 -06003445bool PreCallValidateCreateBufferView(const layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003446 bool skip = false;
Shannon McPherson883f6092018-06-14 13:15:25 -06003447 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003448 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003449 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3450 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003451 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3452 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003453 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3454 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003455 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3456 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3457 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3458 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003459
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003460 // Buffer view offset must be less than the size of buffer
3461 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3462 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3463 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3464 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3465 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3466 pCreateInfo->offset, buffer_state->createInfo.size);
3467 }
3468
Shannon McPherson883f6092018-06-14 13:15:25 -06003469 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
3470 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3471 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3473 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3474 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3475 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3476 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3477 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003478
3479 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003480
3481 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003482 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003483 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003484}
3485
3486void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3487 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3488}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003489
3490// For the given format verify that the aspect masks make sense
3491bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3492 const char *func_name) {
3493 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3494 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003495 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003496 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003497 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 -06003498 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003499 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003500 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003501 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 -06003502 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003503 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003504 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003505 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003506 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003507 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 -06003508 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003509 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003510 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3511 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003512 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003513 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 -06003514 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003515 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003516 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3517 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003518 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003519 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003520 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003521 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 -06003522 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003523 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003524 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003525 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003526 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003527 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003528 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003529 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003530 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003531 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 -06003532 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003533 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003534 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003535 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003536 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003537 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003538 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003539 } else if (FormatIsMultiplane(format)) {
3540 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3541 if (3 == FormatPlaneCount(format)) {
3542 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3543 }
3544 if ((aspect_mask & valid_flags) != aspect_mask) {
3545 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 -06003546 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Dave Houlton501b15b2018-03-30 15:07:41 -06003547 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3548 "set, where n = [0, 1, 2].",
3549 func_name);
3550 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003551 }
3552 return skip;
3553}
3554
Petr Krausffa94af2017-08-08 21:46:02 +02003555struct SubresourceRangeErrorCodes {
Dave Houltond8ed0212018-05-16 17:18:24 -06003556 std::string base_mip_err, mip_count_err, base_layer_err, layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02003557};
3558
3559bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3560 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3561 const char *image_layer_count_var_name, const uint64_t image_handle,
3562 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003563 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3564 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003565
3566 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003567 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003568 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 -06003569 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003570 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003571 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3572 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003573 }
Petr Kraus4d718682017-05-18 03:38:41 +02003574
Petr Krausffa94af2017-08-08 21:46:02 +02003575 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3576 if (subresourceRange.levelCount == 0) {
3577 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 -06003578 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003579 } else {
3580 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003581
Petr Krausffa94af2017-08-08 21:46:02 +02003582 if (necessary_mip_count > image_mip_count) {
3583 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 -06003584 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003585 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003586 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003587 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003588 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003589 }
Petr Kraus4d718682017-05-18 03:38:41 +02003590 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003591 }
Petr Kraus4d718682017-05-18 03:38:41 +02003592
3593 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003594 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003595 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 -06003596 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003597 "%s: %s.baseArrayLayer (= %" PRIu32
3598 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3599 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003600 }
Petr Kraus4d718682017-05-18 03:38:41 +02003601
Petr Krausffa94af2017-08-08 21:46:02 +02003602 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3603 if (subresourceRange.layerCount == 0) {
3604 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 -06003605 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003606 } else {
3607 const uint64_t necessary_layer_count =
3608 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003609
Petr Krausffa94af2017-08-08 21:46:02 +02003610 if (necessary_layer_count > image_layer_count) {
3611 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003612 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003613 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003614 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003615 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003616 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003617 }
Petr Kraus4d718682017-05-18 03:38:41 +02003618 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003619 }
Petr Kraus4d718682017-05-18 03:38:41 +02003620
Mark Lobodzinski602de982017-02-09 11:01:33 -07003621 return skip;
3622}
3623
Petr Krausffa94af2017-08-08 21:46:02 +02003624bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3625 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3626 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3627 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3628 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3629 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3630
3631 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3632 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3633
3634 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003635 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
3636 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
3637 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
3638 : "VUID-VkImageViewCreateInfo-image-01482")
3639 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
3640 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
3641 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
3642 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
3643 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02003644
3645 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3646 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3647 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3648}
3649
3650bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3651 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3652 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003653 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
3654 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
3655 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
3656 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02003657
3658 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3659 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3660 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3661}
3662
3663bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3664 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3665 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003666 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
3667 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
3668 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
3669 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02003670
3671 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3672 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3673 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3674}
3675
3676bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3677 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3678 const char *param_name) {
3679 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06003680 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
3681 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
3682 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
3683 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02003684
3685 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3686 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3687 subresourceRangeErrorCodes);
3688}
3689
Mark Lobodzinski602de982017-02-09 11:01:33 -07003690bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3691 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3692 bool skip = false;
3693 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3694 if (image_state) {
3695 skip |= ValidateImageUsageFlags(
3696 device_data, image_state,
3697 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houltona9df0ce2018-02-07 10:51:23 -07003698 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Dave Houlton8e9f6542018-05-18 12:18:22 -06003699 false, kVUIDUndefined, "vkCreateImageView()",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003700 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3701 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06003702 skip |=
3703 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07003704 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003705 skip |= ValidateCreateImageViewSubresourceRange(
3706 device_data, image_state,
3707 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3708 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003709
3710 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3711 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003712 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3713 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003714 VkFormat view_format = create_info->format;
3715 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003716 VkImageType image_type = image_state->createInfo.imageType;
3717 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003718
Dave Houltonbd2e2622018-04-10 16:41:14 -06003719 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
3720 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
3721 if (chained_ivuci_struct) {
3722 if (chained_ivuci_struct->usage & ~image_usage) {
3723 std::stringstream ss;
3724 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06003725 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06003726 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06003727 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3728 HandleToUint64(create_info->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
3729 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06003730 }
3731
3732 image_usage = chained_ivuci_struct->usage;
3733 }
3734
Dave Houlton6f5f20a2018-05-04 12:37:44 -06003735 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
3736 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06003737 if (FormatIsMultiplane(image_format)) {
3738 // View format must match the multiplane compatible format
3739 uint32_t plane = 3; // invalid
3740 switch (aspect_mask) {
3741 case VK_IMAGE_ASPECT_PLANE_0_BIT:
3742 plane = 0;
3743 break;
3744 case VK_IMAGE_ASPECT_PLANE_1_BIT:
3745 plane = 1;
3746 break;
3747 case VK_IMAGE_ASPECT_PLANE_2_BIT:
3748 plane = 2;
3749 break;
3750 default:
3751 break;
3752 }
3753
3754 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
3755 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003756 std::stringstream ss;
3757 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06003758 << " is not compatible with plane " << plane << " of underlying image format "
3759 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06003760 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3761 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
3762 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06003763 }
3764 } else {
3765 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3766 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3767 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3768 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3769 std::stringstream ss;
3770 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3771 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3772 << ") format " << string_VkFormat(image_format)
3773 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3774 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06003775 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3776 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
3777 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06003778 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003779 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003780 }
3781 } else {
3782 // Format MUST be IDENTICAL to the format the image was created with
3783 if (image_format != view_format) {
3784 std::stringstream ss;
3785 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003786 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003787 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06003788 skip |=
3789 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3790 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07003791 }
3792 }
3793
3794 // Validate correct image aspect bits for desired formats and format consistency
3795 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003796
3797 switch (image_type) {
3798 case VK_IMAGE_TYPE_1D:
3799 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06003800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3801 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003802 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3803 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003804 }
3805 break;
3806 case VK_IMAGE_TYPE_2D:
3807 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3808 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3809 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3811 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003812 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3813 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003814 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06003815 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3816 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003817 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3818 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003819 }
3820 }
3821 break;
3822 case VK_IMAGE_TYPE_3D:
3823 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3824 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3825 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3826 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003827 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06003828 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3829 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003830 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3831 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003832 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3833 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003834 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06003835 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3836 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003837 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3838 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003839 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
3840 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003841 }
3842 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06003843 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3844 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003845 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3846 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003847 }
3848 }
3849 } else {
3850 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06003851 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3852 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003853 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3854 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003855 }
3856 }
3857 break;
3858 default:
3859 break;
3860 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003861
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003862 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003863 bool check_tiling_features = false;
3864 VkFormatFeatureFlags tiling_features = 0;
Dave Houltond8ed0212018-05-16 17:18:24 -06003865 std::string linear_error_codes[] = {
3866 "VUID-VkImageViewCreateInfo-image-01006", "VUID-VkImageViewCreateInfo-image-01008",
3867 "VUID-VkImageViewCreateInfo-image-01009", "VUID-VkImageViewCreateInfo-image-01010",
3868 "VUID-VkImageViewCreateInfo-image-01011",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003869 };
Dave Houltond8ed0212018-05-16 17:18:24 -06003870 std::string optimal_error_codes[] = {
3871 "VUID-VkImageViewCreateInfo-image-01012", "VUID-VkImageViewCreateInfo-image-01013",
3872 "VUID-VkImageViewCreateInfo-image-01014", "VUID-VkImageViewCreateInfo-image-01015",
3873 "VUID-VkImageViewCreateInfo-image-01016",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003874 };
Dave Houltond8ed0212018-05-16 17:18:24 -06003875 std::string *error_codes = nullptr;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003876 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003877 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003878 error_codes = linear_error_codes;
3879 check_tiling_features = true;
3880 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003881 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003882 error_codes = optimal_error_codes;
3883 check_tiling_features = true;
3884 }
3885
3886 if (check_tiling_features) {
3887 if (tiling_features == 0) {
Mark Young9d1ac312018-05-21 16:28:27 -06003888 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3889 HandleToUint64(create_info->image), error_codes[0],
3890 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set.",
3891 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003892 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003893 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3894 HandleToUint64(create_info->image), error_codes[1],
3895 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3896 "VK_IMAGE_USAGE_SAMPLED_BIT flags set.",
3897 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003898 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003899 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3900 HandleToUint64(create_info->image), error_codes[2],
3901 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3902 "VK_IMAGE_USAGE_STORAGE_BIT flags set.",
3903 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003904 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3905 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003906 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3907 HandleToUint64(create_info->image), error_codes[3],
3908 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3909 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set.",
3910 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003911 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3912 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06003913 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3914 HandleToUint64(create_info->image), error_codes[4],
3915 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3916 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set.",
3917 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003918 }
3919 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003920 }
3921 return skip;
3922}
3923
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003924void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3925 auto image_view_map = GetImageViewMap(device_data);
3926 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3927
3928 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003929 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003930 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3931 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003932}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003933
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003934bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3935 BUFFER_STATE *dst_buffer_state) {
3936 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06003937 skip |=
3938 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
3939 skip |=
3940 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003941 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06003942 skip |=
3943 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3944 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3945 skip |=
3946 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3947 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003948 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06003949 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
3950 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003951 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003952 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003953 return skip;
3954}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003955
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003956void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3957 BUFFER_STATE *dst_buffer_state) {
3958 // Update bindings between buffers and cmd buffer
3959 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3960 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003961}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003962
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003963static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003964 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3965 bool skip = false;
3966 auto buffer_state = GetBufferState(device_data, buffer);
3967 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003968 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 -06003969 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01003970 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003971 } else {
3972 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003973 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 -06003974 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003975 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003976 }
3977 }
3978 return skip;
3979}
3980
3981bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3982 VK_OBJECT *obj_struct) {
3983 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003984 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003985 if (GetDisables(device_data)->destroy_image_view) return false;
3986 bool skip = false;
3987 if (*image_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003988 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView",
3989 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003990 }
3991 return skip;
3992}
3993
John Zulauffca05c12018-04-26 16:30:39 -06003994void PreCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3995 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003996 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003997 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003998 (*GetImageViewMap(device_data)).erase(image_view);
3999}
4000
4001bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
4002 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02004003 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004004 if (GetDisables(device_data)->destroy_buffer) return false;
4005 bool skip = false;
4006 if (*buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004007 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004008 }
4009 return skip;
4010}
4011
John Zulauffca05c12018-04-26 16:30:39 -06004012void PreCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004013 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004014 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4015 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4016 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004017 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004018 }
4019 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004020 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004021 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004022 GetBufferMap(device_data)->erase(buffer_state->buffer);
4023}
4024
4025bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
4026 VK_OBJECT *obj_struct) {
4027 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004028 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004029 if (GetDisables(device_data)->destroy_buffer_view) return false;
4030 bool skip = false;
4031 if (*buffer_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004032 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView",
4033 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004034 }
4035 return skip;
4036}
4037
John Zulauffca05c12018-04-26 16:30:39 -06004038void PreCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
4039 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004040 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004041 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004042 GetBufferViewMap(device_data)->erase(buffer_view);
4043}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004044
4045bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
4046 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004047 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004048 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004049 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4050 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004051 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4052 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004053 skip |=
4054 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4055 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004056 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004057 return skip;
4058}
4059
4060void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004061 // Update bindings between buffer and cmd buffer
4062 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004063}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004064
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004065bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4066 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004067 bool skip = false;
4068
4069 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004070 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4071 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004072 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 -06004073 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004074 "%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 -06004075 "and 1, respectively.",
4076 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004077 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004078 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004079
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004080 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4081 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004082 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 -06004083 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004084 "%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 -06004085 "must be 0 and 1, respectively.",
4086 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004087 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004088 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004089
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004090 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4091 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004092 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 -06004093 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004094 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4095 "For 3D images these must be 0 and 1, respectively.",
4096 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004097 }
4098 }
4099
4100 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
4101 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06004102 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06004103 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004104 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 -06004105 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004106 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004107 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
4108 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004109 }
4110
4111 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004112 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004113 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 -06004114 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004115 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4116 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004117 }
4118
4119 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4120 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004121 skip |=
4122 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004123 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004124 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4125 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004126 }
4127
4128 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4129 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4130 skip |= log_msg(
4131 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004132 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004133 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4134 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004135 }
4136
4137 // subresource aspectMask must have exactly 1 bit set
4138 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4139 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4140 if (aspect_mask_bits.count() != 1) {
4141 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 -06004142 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004143 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004144 }
4145
4146 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004147 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004148 skip |= log_msg(
4149 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004150 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004151 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4152 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004153 }
4154
4155 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004156 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004157 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004158
4159 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004160 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004161 skip |= log_msg(
4162 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004163 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004164 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4165 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004166 }
4167
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004168 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004169 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004170 skip |= log_msg(
4171 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004172 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004173 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4174 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004175 }
4176
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004177 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004178 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4179 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4180 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004181 skip |=
4182 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004183 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004184 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4185 "width & height (%d, %d)..",
4186 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004187 }
4188
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004189 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004190 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
4191 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004192 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 -06004193 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004194 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4195 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
4196 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004197 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004198
4199 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004200 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004201 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004202 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4203 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 -06004204 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004205 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004206 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004207 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004208 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004209 }
4210
4211 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004212 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004213 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4214 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 -06004215 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004216 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004217 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004218 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004219 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004220 }
4221
4222 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004223 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004224 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4225 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 -06004226 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004227 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004228 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004229 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004230 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004231 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004232 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004233 }
4234
4235 return skip;
4236}
4237
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004238static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Dave Houltond8ed0212018-05-16 17:18:24 -06004239 const VkBufferImageCopy *pRegions, const char *func_name, std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004240 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004241 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004242
4243 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004244 VkExtent3D extent = pRegions[i].imageExtent;
4245 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004246
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004247 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4248 {
Dave Houlton51653902018-06-22 17:32:13 -06004249 skip |=
4250 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4251 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4252 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004253 }
4254
4255 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4256
4257 // 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 -06004258 if (FormatIsCompressed(image_info->format)) {
4259 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004260 if (image_extent.width % block_extent.width) {
4261 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4262 }
4263 if (image_extent.height % block_extent.height) {
4264 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4265 }
4266 if (image_extent.depth % block_extent.depth) {
4267 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4268 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004269 }
4270
Dave Houltonfc1a4052017-04-27 14:32:45 -06004271 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004272 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 -06004273 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004274 }
4275 }
4276
4277 return skip;
4278}
4279
Chris Forbese8ba09a2017-06-01 17:39:02 -07004280static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004281 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06004282 std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004283 bool skip = false;
4284
4285 VkDeviceSize buffer_size = buff_state->createInfo.size;
4286
4287 for (uint32_t i = 0; i < regionCount; i++) {
4288 VkExtent3D copy_extent = pRegions[i].imageExtent;
4289
4290 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4291 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004292 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004293
Dave Houltonf3229d52017-02-21 15:59:08 -07004294 // Handle special buffer packing rules for specific depth/stencil formats
4295 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004296 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004297 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4298 switch (image_state->createInfo.format) {
4299 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004300 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004301 break;
4302 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004303 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004304 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004305 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004306 case VK_FORMAT_D24_UNORM_S8_UINT:
4307 unit_size = 4;
4308 break;
4309 default:
4310 break;
4311 }
4312 }
4313
Dave Houlton1d2022c2017-03-29 11:43:58 -06004314 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004315 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06004316 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004317 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4318 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4319
4320 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4321 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4322 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004323 }
4324
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004325 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4326 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4327 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004328 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004329 } else {
4330 // Calculate buffer offset of final copied byte, + 1.
4331 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4332 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4333 max_buffer_offset *= unit_size; // convert to bytes
4334 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004335
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004336 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004337 skip |=
4338 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4339 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004340 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004341 }
4342 }
4343
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004344 return skip;
4345}
4346
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004347bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004348 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004349 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004350 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4351 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4352
4353 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004354 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004355
4356 // Command pool must support graphics, compute, or transfer operations
4357 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4358
4359 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4360 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4361 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 -06004362 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004363 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004364 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004365 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004366 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004367 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004368 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004369 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004370
4371 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004372 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4373 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4374 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4375 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4376 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004377
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004378 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004379 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4380 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4381 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004382 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004383 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4384 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004385 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4386 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004387 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00185",
4388 "VUID-vkCmdCopyImageToBuffer-srcImage-00185");
Cort Stratton186b1a22018-05-01 20:18:06 -04004389 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004390 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004391 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004392 const std::string src_invalid_layout_vuid =
4393 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4394 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4395 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004396 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004397 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4398 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004399 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004400 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4401 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004402 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004403 "vkCmdCopyImageToBuffer()",
4404 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004405 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4406 "vkCmdCopyImageToBuffer()", "imageSubresource",
4407 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4408 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4409 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4410 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004411 }
4412 return skip;
4413}
4414
4415void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004416 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4417 VkImageLayout src_image_layout) {
4418 // Make sure that all image slices are updated to correct layout
4419 for (uint32_t i = 0; i < region_count; ++i) {
4420 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4421 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004422 // Update bindings between buffer/image and cmd buffer
4423 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004424 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004425}
4426
4427bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004428 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004429 const VkBufferImageCopy *pRegions, const char *func_name) {
4430 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4431 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4432
4433 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004434 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004435
4436 // Command pool must support graphics, compute, or transfer operations
4437 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4438 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4439 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4440 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 -06004441 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004442 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004443 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004444 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004445 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004446 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004447 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004448 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004449 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004450 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4451 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4452 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4453 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4454 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004455 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004456 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4457 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4458 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4459 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4460 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004461 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4462 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004463 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00175",
4464 "VUID-vkCmdCopyBufferToImage-dstImage-00175");
Cort Stratton186b1a22018-05-01 20:18:06 -04004465 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004466 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004467 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004468 const std::string dst_invalid_layout_vuid =
4469 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4470 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4471 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004472 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004473 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4474 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004475 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004476 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4477 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004478 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004479 "vkCmdCopyBufferToImage()",
4480 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004481 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4482 "vkCmdCopyBufferToImage()", "imageSubresource",
4483 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4484 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4485 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4486 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004487 }
4488 return skip;
4489}
4490
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004491void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004492 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4493 VkImageLayout dst_image_layout) {
4494 // Make sure that all image slices are updated to correct layout
4495 for (uint32_t i = 0; i < region_count; ++i) {
4496 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4497 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004498 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004499 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004500}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004501
4502bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4503 const auto report_data = core_validation::GetReportData(device_data);
4504 bool skip = false;
4505 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4506
Dave Houlton1d960ff2018-01-19 12:17:05 -07004507 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004508 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4509 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4510 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004511 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 -06004512 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004513 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004514 }
4515
4516 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4517 if (!image_entry) {
4518 return skip;
4519 }
4520
Dave Houlton1d960ff2018-01-19 12:17:05 -07004521 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004522 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004523 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4524 "VUID-vkGetImageSubresourceLayout-image-00996",
4525 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004526 }
4527
Dave Houlton1d960ff2018-01-19 12:17:05 -07004528 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004529 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004530 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4531 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4532 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4533 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004534 }
4535
Dave Houlton1d960ff2018-01-19 12:17:05 -07004536 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004537 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004538 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4539 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4540 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4541 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004542 }
4543
Dave Houlton1d960ff2018-01-19 12:17:05 -07004544 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004545 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004546 if (FormatIsMultiplane(img_format)) {
4547 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Dave Houltond8ed0212018-05-16 17:18:24 -06004548 std::string vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004549 if (FormatPlaneCount(img_format) > 2u) {
4550 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004551 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004552 }
4553 if (sub_aspect != (sub_aspect & allowed_flags)) {
4554 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 -06004555 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004556 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004557 ") must be a single-plane specifier flag.",
4558 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004559 }
4560 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004561 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004562 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004563 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004564 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004565 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004566 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004567 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004568 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004569 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 -06004570 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004571 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004572 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004573 }
4574 }
4575 return skip;
4576}