blob: aee6e9eccade38f7c5ba0264640201f355f0ceb7 [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
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060025#include <cmath>
26#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020028#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070029
30#include "vk_enum_string_helper.h"
31#include "vk_layer_data.h"
32#include "vk_layer_utils.h"
33#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060034#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070035
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070036#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070037
Tobin Ehlis58c884f2017-02-08 12:15:27 -070038void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070039 auto it = pCB->imageLayoutMap.find(imgpair);
40 if (it != pCB->imageLayoutMap.end()) {
41 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070042 } else {
43 assert(imgpair.hasSubresource);
44 IMAGE_CMD_BUF_LAYOUT_NODE node;
45 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
46 node.initialLayout = layout;
47 }
48 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
49 }
50}
51template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070052void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070053 ImageSubresourcePair imgpair = {image, true, range};
54 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
55 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
56 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
57 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -070058 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
59 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
60 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
61 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
62 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070063}
64
65template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070066void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070067 VkImageAspectFlags aspectMask) {
68 if (imgpair.subresource.aspectMask & aspectMask) {
69 imgpair.subresource.aspectMask = aspectMask;
70 SetLayout(device_data, pObject, imgpair, layout);
71 }
72}
73
Tony Barbourdf013b92017-01-25 12:53:48 -070074// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070075void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
76 VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070077 auto it = imageLayoutMap.find(imgpair);
78 if (it != imageLayoutMap.end()) {
79 it->second.layout = layout; // Update
80 } else {
81 imageLayoutMap[imgpair].layout = layout; // Insert
82 }
Tony Barbourdf013b92017-01-25 12:53:48 -070083}
84
Tobin Ehlisc8266452017-04-07 12:20:30 -060085bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070086 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
87 const debug_report_data *report_data = core_validation::GetReportData(device_data);
88
89 if (!(imgpair.subresource.aspectMask & aspectMask)) {
90 return false;
91 }
92 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
93 imgpair.subresource.aspectMask = aspectMask;
94 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
95 if (imgsubIt == pCB->imageLayoutMap.end()) {
96 return false;
97 }
98 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +020099 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 -0600100 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700101 "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 +0200102 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700103 string_VkImageLayout(imgsubIt->second.layout));
104 }
105 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200106 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 -0600107 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700108 "Cannot query for VkImage 0x%" PRIx64
109 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200110 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700111 string_VkImageLayout(imgsubIt->second.initialLayout));
112 }
113 node = imgsubIt->second;
114 return true;
115}
116
Tobin Ehlisc8266452017-04-07 12:20:30 -0600117bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700118 const VkImageAspectFlags aspectMask) {
119 if (!(imgpair.subresource.aspectMask & aspectMask)) {
120 return false;
121 }
122 const debug_report_data *report_data = core_validation::GetReportData(device_data);
123 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
124 imgpair.subresource.aspectMask = aspectMask;
125 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
126 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
127 return false;
128 }
129 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200130 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 -0600131 kVUID_Core_DrawState_InvalidLayout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700132 "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 +0200133 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700134 string_VkImageLayout(imgsubIt->second.layout));
135 }
136 layout = imgsubIt->second.layout;
137 return true;
138}
139
140// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600141bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700142 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
143 ImageSubresourcePair imgpair = {image, true, range};
144 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
145 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
146 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
147 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
148 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700149 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
150 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
151 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
152 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
153 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700154 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
155 imgpair = {image, false, VkImageSubresource()};
156 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
157 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
158 // TODO: This is ostensibly a find function but it changes state here
159 node = imgsubIt->second;
160 }
161 return true;
162}
163
164// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700165bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700166 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
167 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
168 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
169 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
170 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700171 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
172 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
173 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
174 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
175 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700176 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
177 imgpair = {imgpair.image, false, VkImageSubresource()};
178 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
179 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
180 layout = imgsubIt->second.layout;
181 }
182 return true;
183}
184
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700185bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700186 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
187 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700188 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700189 if (!image_state) return false;
190 bool ignoreGlobal = false;
191 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
192 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
193 ignoreGlobal = true;
194 }
195 for (auto imgsubpair : sub_data->second) {
196 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
197 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
198 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
199 layouts.push_back(img_data->second.layout);
200 }
201 }
202 return true;
203}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700204bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
205 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700206 if (!(imgpair.subresource.aspectMask & aspectMask)) {
207 return false;
208 }
209 imgpair.subresource.aspectMask = aspectMask;
210 auto imgsubIt = imageLayoutMap.find(imgpair);
211 if (imgsubIt == imageLayoutMap.end()) {
212 return false;
213 }
214 layout = imgsubIt->second.layout;
215 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700216}
Tony Barbourdf013b92017-01-25 12:53:48 -0700217
218// find layout in supplied map
Dave Houltonb3f4b282018-02-22 16:25:16 -0700219bool FindLayout(layer_data *device_data, const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
220 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700221 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
222 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
223 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
224 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
225 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700226 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
227 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
228 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
229 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
230 }
231 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700232 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
233 imgpair = {imgpair.image, false, VkImageSubresource()};
234 auto imgsubIt = imageLayoutMap.find(imgpair);
235 if (imgsubIt == imageLayoutMap.end()) return false;
236 layout = imgsubIt->second.layout;
237 }
238 return true;
239}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700240
241// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700242void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700243 VkImage &image = imgpair.image;
Dave Houltonb3f4b282018-02-22 16:25:16 -0700244 auto &lmap = (*core_validation::GetImageLayoutMap(device_data));
245 auto data = lmap.find(imgpair);
246 if (data != lmap.end()) {
247 data->second.layout = layout; // Update
248 } else {
249 lmap[imgpair].layout = layout; // Insert
250 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700251 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
252 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
253 if (subresource == image_subresources.end()) {
254 image_subresources.push_back(imgpair);
255 }
256}
257
258// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700259void 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 -0700260 auto it = pCB->imageLayoutMap.find(imgpair);
261 if (it != pCB->imageLayoutMap.end()) {
262 it->second = node; // Update
263 } else {
264 pCB->imageLayoutMap[imgpair] = node; // Insert
265 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700266}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600267// Set image layout for given VkImageSubresourceRange struct
268void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
269 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
270 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700271 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600272 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
273 uint32_t level = image_subresource_range.baseMipLevel + level_index;
274 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
275 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
276 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700277 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
278 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600279 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600280 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700281 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
282 }
283 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600284 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700285 }
286 }
287}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600288// Set image layout for given VkImageSubresourceLayers struct
289void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
290 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
291 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
292 VkImageSubresourceRange image_subresource_range;
293 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
294 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
295 image_subresource_range.layerCount = image_subresource_layers.layerCount;
296 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
297 image_subresource_range.levelCount = 1;
298 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
299}
Dave Houltonddd65c52018-05-08 14:58:01 -0600300
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600301// Set image layout for all slices of an image view
John Zulauf4ccf5c02018-09-21 11:46:18 -0600302void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_VIEW_STATE *view_state,
303 const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600304 assert(view_state);
305
Dave Houltonddd65c52018-05-08 14:58:01 -0600306 IMAGE_STATE *image_state = GetImageState(device_data, view_state->create_info.image);
307 VkImageSubresourceRange sub_range = view_state->create_info.subresourceRange;
308
309 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
310 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
311 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state->create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
312 sub_range.baseArrayLayer = 0;
313 sub_range.layerCount = image_state->createInfo.extent.depth;
314 }
315
316 SetImageLayout(device_data, cb_node, image_state, sub_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600317}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700318
John Zulauf4ccf5c02018-09-21 11:46:18 -0600319void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
320 auto view_state = GetImageViewState(device_data, imageView);
321 SetImageViewLayout(device_data, cb_node, view_state, layout);
322}
323
Tobias Hectorbbb12282018-10-22 15:17:59 +0100324bool ValidateRenderPassLayoutAgainstFramebufferImageUsage(layer_data *device_data, RenderPassCreateVersion rp_version,
325 VkImageLayout layout, VkImage image, VkImageView image_view,
326 VkFramebuffer framebuffer, VkRenderPass renderpass,
327 uint32_t attachment_index, const char *variable_name) {
328 bool skip = false;
329 const auto report_data = core_validation::GetReportData(device_data);
330 auto image_state = GetImageState(device_data, image);
331 const char *vuid;
332 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
333
334 if (!image_state) {
335 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
336 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
337 "Render Pass begin with renderpass 0x%" PRIx64 " uses framebuffer 0x%" PRIx64 " where pAttachments[%" PRIu32
338 "] = image view 0x%" PRIx64 ", which refers to an invalid image",
339 HandleToUint64(renderpass), HandleToUint64(framebuffer), attachment_index, HandleToUint64(image_view));
340 return skip;
341 }
342
343 auto image_usage = image_state->createInfo.usage;
344
345 // Check for layouts that mismatch image usages in the framebuffer
346 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
347 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
348 skip |=
349 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
350 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
351 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
352 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
353 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
354 HandleToUint64(renderpass), HandleToUint64(image_view));
355 }
356
357 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
358 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
359 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
360 skip |=
361 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
362 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
363 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
364 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
365 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
366 HandleToUint64(renderpass), HandleToUint64(image_view));
367 }
368
369 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
370 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
371 skip |=
372 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
373 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
374 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
375 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
376 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
377 HandleToUint64(renderpass), HandleToUint64(image_view));
378 }
379
380 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
381 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
382 skip |=
383 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
384 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
385 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
386 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
387 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
388 HandleToUint64(renderpass), HandleToUint64(image_view));
389 }
390
391 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
392 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
393 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
394 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
395 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
396 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
397 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
398 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
399 HandleToUint64(image), vuid,
400 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
401 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
402 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
403 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
404 HandleToUint64(renderpass), HandleToUint64(image_view));
405 }
406 } else {
407 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
408 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
409 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
410 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
411 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
412 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
413 "Layout/usage mismatch for attachment %u in render pass 0x%" PRIx64
414 " - the %s is %s but the image attached to framebuffer 0x%" PRIx64 " via image view 0x%" PRIx64
415 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
416 attachment_index, HandleToUint64(framebuffer), variable_name, string_VkImageLayout(layout),
417 HandleToUint64(renderpass), HandleToUint64(image_view));
418 }
419 }
420 return skip;
421}
422
423bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700424 const VkRenderPassBeginInfo *pRenderPassBegin,
425 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600426 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700427 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700428 auto const &framebufferInfo = framebuffer_state->createInfo;
429 const auto report_data = core_validation::GetReportData(device_data);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100430
431 auto render_pass = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->renderPass;
432 auto framebuffer = framebuffer_state->framebuffer;
433
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700434 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600435 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 -0600436 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700437 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700438 }
439 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
440 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700441 auto view_state = GetImageViewState(device_data, image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600442
443 if (!view_state) {
444 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
445 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
446 "vkCmdBeginRenderPass() :framebuffer 0x%" PRIx64 " pAttachments[%" PRIu32 "] = 0x%" PRIx64
447 " is not a valid VkImageView handle",
448 HandleToUint64(framebuffer_state->framebuffer), i, HandleToUint64(image_view));
449 continue;
450 }
451
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700452 const VkImage &image = view_state->create_info.image;
453 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700454 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100455 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
456
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700457 // TODO: Do not iterate over every possibility - consolidate where possible
458 for (uint32_t j = 0; j < subRange.levelCount; j++) {
459 uint32_t level = subRange.baseMipLevel + j;
460 for (uint32_t k = 0; k < subRange.layerCount; k++) {
461 uint32_t layer = subRange.baseArrayLayer + k;
462 VkImageSubresource sub = {subRange.aspectMask, level, layer};
463 IMAGE_CMD_BUF_LAYOUT_NODE node;
464 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700465 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700466 continue;
467 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700468 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600469 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 -0600470 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700471 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
472 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
473 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600474 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700475 }
476 }
477 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100478
479 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, initial_layout, image, image_view,
480 framebuffer, render_pass, i, "initial layout");
481
482 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, final_layout, image, image_view, framebuffer,
483 render_pass, i, "final layout");
484 }
485
486 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
487 auto &subpass = pRenderPassInfo->pSubpasses[j];
488 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
489 auto &attachment_ref = subpass.pInputAttachments[k];
490 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
491 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
492 auto view_state = GetImageViewState(device_data, image_view);
493
494 if (view_state) {
495 auto image = view_state->create_info.image;
496 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
497 image_view, framebuffer, render_pass,
498 attachment_ref.attachment, "input attachment layout");
499 }
500 }
501 }
502
503 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
504 auto &attachment_ref = subpass.pColorAttachments[k];
505 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
506 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
507 auto view_state = GetImageViewState(device_data, image_view);
508
509 if (view_state) {
510 auto image = view_state->create_info.image;
511 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
512 image_view, framebuffer, render_pass,
513 attachment_ref.attachment, "color attachment layout");
514 if (subpass.pResolveAttachments) {
515 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
516 device_data, rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
517 attachment_ref.attachment, "resolve attachment layout");
518 }
519 }
520 }
521 }
522
523 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
524 auto &attachment_ref = *subpass.pDepthStencilAttachment;
525 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
526 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
527 auto view_state = GetImageViewState(device_data, image_view);
528
529 if (view_state) {
530 auto image = view_state->create_info.image;
531 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
532 image_view, framebuffer, render_pass,
533 attachment_ref.attachment, "input attachment layout");
534 }
535 }
536 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700537 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600538 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700539}
540
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700541void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Tobias Hectorbbb12282018-10-22 15:17:59 +0100542 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700543 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf8e308292018-09-21 11:34:37 -0600544 auto image_view = GetAttachmentImageViewState(device_data, pFramebuffer, ref.attachment);
545 if (image_view) {
546 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
547 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700548 }
549}
550
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700551void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700552 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700553 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700554
555 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700556 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700557 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
558 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
559 }
560 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
561 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
562 }
563 if (subpass.pDepthStencilAttachment) {
564 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
565 }
566 }
567}
568
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600569bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700570 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700571 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
572 return false;
573 }
574 VkImageSubresource sub = {aspect, level, layer};
575 IMAGE_CMD_BUF_LAYOUT_NODE node;
576 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700577 return false;
578 }
579 bool skip = false;
580 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
581 // TODO: Set memory invalid which is in mem_tracker currently
582 } else if (node.layout != mem_barrier->oldLayout) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600583 skip = log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
584 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
585 "VUID-VkImageMemoryBarrier-oldLayout-01197",
586 "For image 0x%" PRIx64
587 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
588 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
589 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700590 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700591 return skip;
592}
593
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700594// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
595// 1. Transition into initialLayout state
596// 2. Transition from initialLayout to layout used in subpass 0
597void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
598 FRAMEBUFFER_STATE *framebuffer_state) {
599 // First transition into initialLayout
600 auto const rpci = render_pass_state->createInfo.ptr();
601 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -0600602 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
603 if (view_state) {
604 SetImageViewLayout(device_data, cb_state, view_state, rpci->pAttachments[i].initialLayout);
605 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700606 }
607 // Now transition for first subpass (index 0)
608 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
609}
610
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700611void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
Tony-LunarG0d27b302018-10-08 09:26:21 -0600612 uint32_t level, uint32_t layer, VkImageAspectFlags aspect_mask, VkImageAspectFlags aspect) {
613 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700614 return;
615 }
616 VkImageSubresource sub = {aspect, level, layer};
617 IMAGE_CMD_BUF_LAYOUT_NODE node;
618 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700619 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700620 SetLayout(device_data, pCB, mem_barrier->image, sub,
621 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
622 return;
623 }
624 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
625 // TODO: Set memory invalid
626 }
627 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
628}
629
Dave Houlton10b39482017-03-16 13:18:15 -0600630bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600631 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600632 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600633 }
634 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600635 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600636 }
637 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600638 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600639 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700640 if (0 !=
641 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
642 if (FormatPlaneCount(format) == 1) return false;
643 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600644 return true;
645}
646
Mike Weiblen62d08a32017-03-07 22:18:27 -0700647// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
648bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
649 VkImageUsageFlags usage_flags, const char *func_name) {
650 const auto report_data = core_validation::GetReportData(device_data);
651 bool skip = false;
652 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Dave Houlton8e9f6542018-05-18 12:18:22 -0600653 std::string msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700654
655 switch (layout) {
656 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
657 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600658 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700659 }
660 break;
661 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
662 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600663 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700664 }
665 break;
666 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
667 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600668 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700669 }
670 break;
671 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
672 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600673 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700674 }
675 break;
676 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
677 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600678 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700679 }
680 break;
681 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
682 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600683 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684 }
685 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600686 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500687 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
688 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
689 }
690 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700691 default:
692 // Other VkImageLayout values do not have VUs defined in this context.
693 break;
694 }
695
Dave Houlton8e9f6542018-05-18 12:18:22 -0600696 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600697 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 -0600698 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600699 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
700 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
701 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700702 }
703 return skip;
704}
705
John Zulauf463c51e2018-05-31 13:29:20 -0600706// Scoreboard for checking for duplicate and inconsistent barriers to images
707struct ImageBarrierScoreboardEntry {
708 uint32_t index;
709 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
710 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
711 const VkImageMemoryBarrier *barrier;
712};
713using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
714using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
715
Mike Weiblen62d08a32017-03-07 22:18:27 -0700716// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600717bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700718 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700719 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700720
John Zulauf463c51e2018-05-31 13:29:20 -0600721 // Scoreboard for duplicate layout transition barriers within the list
722 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
723 ImageBarrierScoreboardImageMap layout_transitions;
724
Mike Weiblen62d08a32017-03-07 22:18:27 -0700725 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
726 auto img_barrier = &pImageMemoryBarriers[i];
727 if (!img_barrier) continue;
728
John Zulauf463c51e2018-05-31 13:29:20 -0600729 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
730 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
731 // at a per sub-resource level
732 if (img_barrier->oldLayout != img_barrier->newLayout) {
733 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
734 auto image_it = layout_transitions.find(img_barrier->image);
735 if (image_it != layout_transitions.end()) {
736 auto &subres_map = image_it->second;
737 auto subres_it = subres_map.find(img_barrier->subresourceRange);
738 if (subres_it != subres_map.end()) {
739 auto &entry = subres_it->second;
740 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
741 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
742 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
743 skip = log_msg(
744 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
745 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_state->commandBuffer),
746 "VUID-VkImageMemoryBarrier-oldLayout-01197",
747 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image 0x%" PRIx64
748 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
749 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
750 func_name, i, entry.index, HandleToUint64(img_barrier->image), range.aspectMask, range.baseMipLevel,
751 range.levelCount, range.baseArrayLayer, range.layerCount, string_VkImageLayout(img_barrier->oldLayout),
752 string_VkImageLayout(entry.barrier->newLayout));
753 }
754 entry = new_entry;
755 } else {
756 subres_map[img_barrier->subresourceRange] = new_entry;
757 }
758 } else {
759 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
760 }
761 }
762
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600763 auto image_state = GetImageState(device_data, img_barrier->image);
764 if (image_state) {
765 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
766 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
767 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
768
769 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
770 if (image_state->layout_locked) {
771 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600772 skip |= log_msg(
773 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Young9d1ac312018-05-21 16:28:27 -0600774 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100775 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600776 " 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 +0100777 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600778 string_VkImageLayout(img_barrier->newLayout));
779 }
780 }
781
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600782 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600783 // For a Depth/Stencil image both aspects MUST be set
784 if (FormatIsDepthAndStencil(image_create_info->format)) {
785 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
786 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
787 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600788 skip |=
789 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -0600790 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image),
791 "VUID-VkImageMemoryBarrier-image-01207",
Mark Lobodzinski88529492018-04-01 10:38:15 -0600792 "%s: Image barrier 0x%p references image 0x%" PRIx64
793 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
794 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
795 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600796 }
797 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600798 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
799 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700800
Mike Weiblen62d08a32017-03-07 22:18:27 -0700801 for (uint32_t j = 0; j < level_count; j++) {
802 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
803 for (uint32_t k = 0; k < layer_count; k++) {
804 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600805 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
806 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
807 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
808 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700809 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
810 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
811 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
812 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
813 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
814 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
815 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
816 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700817 }
818 }
819 }
820 return skip;
821}
822
Chris Forbes4de4b132017-08-21 11:27:08 -0700823static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600824 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700825
826 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600827 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700828}
829
John Zulauf6b4aae82018-05-09 13:03:36 -0600830template <typename Barrier>
831bool ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
832 uint32_t barrier_count, const Barrier *barriers) {
833 using BarrierRecord = QFOTransferBarrier<Barrier>;
834 bool skip = false;
835 const auto report_data = core_validation::GetReportData(device_data);
836 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
837 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
838 const char *barrier_name = BarrierRecord::BarrierName();
839 const char *handle_name = BarrierRecord::HandleName();
840 const char *transfer_type = nullptr;
841 for (uint32_t b = 0; b < barrier_count; b++) {
842 if (!IsTransferOp(&barriers[b])) continue;
843 const BarrierRecord *barrier_record = nullptr;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600844 if (IsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600845 const auto found = barrier_sets.release.find(barriers[b]);
846 if (found != barrier_sets.release.cend()) {
847 barrier_record = &(*found);
848 transfer_type = "releasing";
849 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600850 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
851 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600852 const auto found = barrier_sets.acquire.find(barriers[b]);
853 if (found != barrier_sets.acquire.cend()) {
854 barrier_record = &(*found);
855 transfer_type = "acquiring";
856 }
857 }
858 if (barrier_record != nullptr) {
859 skip |=
860 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
861 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
862 "%s: %s at index %" PRIu32 " %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
863 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
864 func_name, barrier_name, b, transfer_type, handle_name, HandleToUint64(barrier_record->handle),
865 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
866 }
867 }
868 return skip;
869}
870
871template <typename Barrier>
872void RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
873 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
874 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
875 for (uint32_t b = 0; b < barrier_count; b++) {
876 if (!IsTransferOp(&barriers[b])) continue;
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600877 if (IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) && !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600878 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600879 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
880 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600881 barrier_sets.acquire.emplace(barriers[b]);
882 }
883 }
884}
885
886bool ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
887 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
888 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
889 bool skip = false;
890 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
891 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
892 return skip;
893}
894
895void RecordBarriersQFOTransfers(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
896 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
897 uint32_t imageMemBarrierCount, const VkImageMemoryBarrier *pImageMemBarriers) {
898 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
899 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
900}
901
902template <typename BarrierRecord, typename Scoreboard>
903static bool ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
904 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
905 // Record to the scoreboard or report that we have a duplication
906 bool skip = false;
907 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
908 if (!inserted.second && inserted.first->second != cb_state) {
909 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
910 skip = log_msg(
911 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
912 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
913 "%s: %s %s queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
914 " duplicates existing barrier submitted in this batch from command buffer 0x%" PRIx64 ".",
915 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(), HandleToUint64(barrier.handle),
916 barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex, HandleToUint64(inserted.first->second));
917 }
918 return skip;
919}
920
921template <typename Barrier>
922static bool ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
923 QFOTransferCBScoreboards<Barrier> *scoreboards) {
924 using BarrierRecord = QFOTransferBarrier<Barrier>;
925 using TypeTag = typename BarrierRecord::Tag;
926 bool skip = false;
927 const auto report_data = core_validation::GetReportData(device_data);
928 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
929 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
930 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
931 const char *barrier_name = BarrierRecord::BarrierName();
932 const char *handle_name = BarrierRecord::HandleName();
933 // No release should have an extant duplicate (WARNING)
934 for (const auto &release : cb_barriers.release) {
935 // Check the global pending release barriers
936 const auto set_it = global_release_barriers.find(release.handle);
937 if (set_it != global_release_barriers.cend()) {
938 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
939 const auto found = set_for_handle.find(release);
940 if (found != set_for_handle.cend()) {
941 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
942 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
943 "%s: %s releasing queue ownership of %s (0x%" PRIx64 "), from srcQueueFamilyIndex %" PRIu32
944 " to dstQueueFamilyIndex %" PRIu32
945 " duplicates existing barrier queued for execution, without intervening acquire operation.",
946 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(found->handle),
947 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
948 }
949 }
950 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
951 }
952 // Each acquire must have a matching release (ERROR)
953 for (const auto &acquire : cb_barriers.acquire) {
954 const auto set_it = global_release_barriers.find(acquire.handle);
955 bool matching_release_found = false;
956 if (set_it != global_release_barriers.cend()) {
957 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
958 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
959 }
960 if (!matching_release_found) {
961 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
962 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
963 "%s: in submitted command buffer %s aquiring ownership of %s (0x%" PRIx64
964 "), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
965 " has no matching release barrier queued for execution.",
966 "vkQueueSubmit()", barrier_name, handle_name, HandleToUint64(acquire.handle),
967 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
968 }
969 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
970 }
971 return skip;
972}
973
974bool ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
975 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
976 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
977 bool skip = false;
978 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
979 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
980 return skip;
981}
982
983template <typename Barrier>
984static void RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
985 using BarrierRecord = QFOTransferBarrier<Barrier>;
986 using TypeTag = typename BarrierRecord::Tag;
987 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
988 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
989 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
990
991 // Add release barriers from this submit to the global map
992 for (const auto &release : cb_barriers.release) {
993 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
994 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
995 global_release_barriers[release.handle].insert(release);
996 }
997
998 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
999 for (const auto &acquire : cb_barriers.acquire) {
1000 // NOTE: We're not using [] because we don't want to create entries for missing releases
1001 auto set_it = global_release_barriers.find(acquire.handle);
1002 if (set_it != global_release_barriers.end()) {
1003 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1004 set_for_handle.erase(acquire);
1005 if (set_for_handle.size() == 0) { // Clean up empty sets
1006 global_release_barriers.erase(set_it);
1007 }
1008 }
1009 }
1010}
1011
1012void RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
1013 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1014 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1015}
1016
1017// Remove the pending QFO release records from the global set
1018// Note that the type of the handle argument constrained to match Barrier type
1019// The defaulted BarrierRecord argument allows use to declare the type once, but is not intended to be specified by the caller
1020template <typename Barrier, typename BarrierRecord = QFOTransferBarrier<Barrier>>
1021static void EraseQFOReleaseBarriers(layer_data *device_data, const typename BarrierRecord::HandleType &handle) {
1022 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers =
1023 core_validation::GetGlobalQFOReleaseBarrierMap(device_data, typename BarrierRecord::Tag());
1024 global_release_barriers.erase(handle);
1025}
1026
1027// Avoid making the template globally visible by exporting the one instance of it we need.
1028void EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
1029 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1030}
1031
Chris Forbes399a6782017-08-18 15:00:48 -07001032void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001033 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001034 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1035 auto mem_barrier = &pImgMemBarriers[i];
1036 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001037
Chris Forbes4de4b132017-08-21 11:27:08 -07001038 // For ownership transfers, the barrier is specified twice; as a release
1039 // operation on the yielding queue family, and as an acquire operation
1040 // on the acquiring queue family. This barrier may also include a layout
1041 // transition, which occurs 'between' the two operations. For validation
1042 // purposes it doesn't seem important which side performs the layout
1043 // transition, but it must not be performed twice. We'll arbitrarily
1044 // choose to perform it as part of the acquire operation.
1045 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
1046 continue;
1047 }
1048
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001049 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
1050 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1051 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1052
Dave Houltonb3f4b282018-02-22 16:25:16 -07001053 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1054 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1055 // for all (potential) layer sub_resources.
1056 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1057 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1058 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1059 }
1060
Tony-LunarG0d27b302018-10-08 09:26:21 -06001061 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1062 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
1063 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1064 if (FormatIsMultiplane(image_create_info->format)) {
1065 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1066 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1067 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1068 if (FormatPlaneCount(image_create_info->format) > 2) {
1069 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1070 }
1071 }
1072 }
1073 }
1074
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001075 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001076 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001077 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001078 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Tony-LunarG0d27b302018-10-08 09:26:21 -06001079 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1080 VK_IMAGE_ASPECT_COLOR_BIT);
1081 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1082 VK_IMAGE_ASPECT_DEPTH_BIT);
1083 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1084 VK_IMAGE_ASPECT_STENCIL_BIT);
1085 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1086 VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001087 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001088 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1089 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1090 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1091 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1092 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1093 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001094 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001095 }
1096 }
1097 }
1098}
1099
Tobin Ehlisc8266452017-04-07 12:20:30 -06001100bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001101 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07001102 const char *caller, const std::string &layout_invalid_msg_code, const std::string &layout_mismatch_msg_code,
1103 bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001104 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001105 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001106 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001107
1108 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1109 uint32_t layer = i + subLayers.baseArrayLayer;
1110 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1111 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001112 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1113 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001114 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001115 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1116 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1117 "%s: Cannot use image 0x%" PRIx64
1118 " (layer=%u mip=%u) with specific layout %s that doesn't match the actual current layout %s.",
1119 caller, HandleToUint64(image), layer, subLayers.mipLevel, string_VkImageLayout(explicit_layout),
1120 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001121 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001122 }
1123 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001124 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1125 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1126 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001127 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1128 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001129 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001130 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001131 kVUID_Core_DrawState_InvalidImageLayout,
Petr Kraus13c98a62017-12-09 00:22:39 +01001132 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
1133 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001134 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001135 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001136 if (image_state->shared_presentable) {
1137 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001138 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1139 layout_invalid_msg_code,
1140 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1141 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001142 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001143 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001144 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001145 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001146 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 -07001147 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001148 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1149 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001150 }
1151 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001152 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001153}
1154
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001155void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
1156 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001157 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001158 if (!renderPass) return;
1159
Tobias Hectorbbb12282018-10-22 15:17:59 +01001160 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001161 if (framebuffer_state) {
1162 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
John Zulauf8e308292018-09-21 11:34:37 -06001163 auto view_state = GetAttachmentImageViewState(device_data, framebuffer_state, i);
1164 if (view_state) {
1165 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
1166 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001167 }
1168 }
1169}
Dave Houltone19e20d2018-02-02 16:32:41 -07001170
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001171#ifdef VK_USE_PLATFORM_ANDROID_KHR
1172// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1173// This could also move into a seperate core_validation_android.cpp file... ?
1174
1175//
1176// AHB-specific validation within non-AHB APIs
1177//
1178bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1179 const VkImageCreateInfo *create_info) {
1180 bool skip = false;
1181
1182 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1183 if (ext_fmt_android) {
1184 auto ahb_formats = GetAHBExternalFormatsSet(device_data);
1185 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1186 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1187 "VUID-VkExternalFormatANDROID-externalFormat-01894",
1188 "vkCreateImage: Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
1189 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1190 }
1191 }
1192
1193 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1194 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1195 bool failed_01892 = true; // Assume failure
1196 do { // once-through only, breaking out means we've detected the failure
1197 if (create_info->imageType != VK_IMAGE_TYPE_2D) break;
1198
1199 uint32_t max_dim = std::max({create_info->extent.height, create_info->extent.width, create_info->extent.depth});
1200 uint32_t full_mip_depth = 1 + (uint32_t)log2(max_dim); // floor() is implicit in the cast
1201 if ((create_info->mipLevels != 1) && (create_info->mipLevels != full_mip_depth)) break;
1202
1203 if (create_info->format == VK_FORMAT_UNDEFINED) {
1204 if (nullptr == ext_fmt_android) break;
1205 if (0 == ext_fmt_android->externalFormat) break;
1206 } else {
1207 // Inputs
1208 VkPhysicalDeviceExternalImageFormatInfo eifi = {};
1209 eifi.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO;
1210 eifi.handleType = VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID;
1211 VkPhysicalDeviceImageFormatInfo2 info = {};
1212 info.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2_KHR;
1213 info.pNext = &eifi; // chain the external format info
1214 info.format = create_info->format;
1215 info.type = create_info->imageType;
1216 info.tiling = create_info->tiling;
1217 info.usage = create_info->usage;
1218 info.flags = create_info->flags;
1219 // Outputs
1220 VkExternalImageFormatProperties eifp = {};
1221 eifp.sType = VK_STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES;
1222 VkImageFormatProperties2 props = {};
1223 props.sType = VK_STRUCTURE_TYPE_IMAGE_FORMAT_PROPERTIES_2;
1224 props.pNext = &eifp; // chain the external image properties
1225 if (VK_SUCCESS != GetPDImageFormatProperties2(device_data, &info, &props)) break;
1226 }
1227 failed_01892 = false; // If we reach here, no error found
1228 } while (false);
1229 if (failed_01892) {
1230 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1231 "VUID-VkImageCreateInfo-pNext-01892",
1232 "vkCreateImage: VkImageCreateInfo struct contains values incompatible with the chained "
1233 "VkExternalMemoryImageCreateInfo struct.");
1234 }
1235 } // End 01892 check
1236
1237 if (ext_fmt_android && 0 != ext_fmt_android->externalFormat) {
1238 if ((VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags) || (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage) ||
1239 (VK_IMAGE_TILING_OPTIMAL != create_info->tiling)) {
1240 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1241 "VUID-VkImageCreateInfo-pNext-01893",
1242 "vkCreateImage: Illegal flags, usage or tiling specified in VkImageCreateInfo struct with a chained "
1243 "VkExternalFormatANDROID struct whose external format is non-zero.");
1244 }
1245 }
1246
1247 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
1248 if (VK_FORMAT_UNDEFINED != create_info->format) {
1249 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1250 "VUID-VkImageCreateInfo-pNext-01974",
1251 "vkCreateImage: VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1252 "external format, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1253 }
1254 } else {
1255 if (VK_FORMAT_UNDEFINED == create_info->format) {
1256 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1257 "VUID-VkImageCreateInfo-pNext-01975",
1258 "vkCreateImage: VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1259 "chained VkExternalFormatANDROID struct or the struct exists but has an external format of 0.");
1260 }
1261 }
1262
1263 return skip;
1264}
1265
1266void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
1267 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1268 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1269 is_node->imported_ahb = true;
1270 }
1271}
1272
1273bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
1274 bool skip = false;
1275 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1276 const VkExternalFormatANDROID *ext_format_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1277 if (ext_format_android) {
1278 // Traverse all the ways VU 01896 can fail. Breaking out at any point indicates a VU violation
1279 bool vu_01896 = true; // assume error
1280 do {
1281 // Errors in create_info struct
1282 if ((create_info->format != VK_FORMAT_UNDEFINED) | (create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) |
1283 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) |
1284 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) |
1285 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1286 break;
1287 }
1288
1289 // Chain must include a cbcr conversion
1290 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info =
1291 lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1292 if (ycbcr_conv_info == nullptr) {
1293 break;
1294 }
1295
1296 // External formats must match
1297 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
1298 auto fmap = GetYcbcrConversionFormatMap(device_data);
1299 if (fmap->find(conv_handle) == fmap->end()) {
1300 break;
1301 }
1302 if (fmap->at(conv_handle) != ext_format_android->externalFormat) {
1303 break;
1304 }
1305 vu_01896 = false; // No error if we reach here
1306 } while (false); // one time through only
1307
1308 if (vu_01896) {
1309 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1310 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01896",
1311 "vkCreateImageView(): VkExternalFormatANDROID struct chained with an illegal combination of "
1312 "format, swizzle, or external format specified.");
1313 }
1314 }
1315 return skip;
1316}
1317
1318bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
1319 bool skip = false;
1320 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1321
1322 IMAGE_STATE *image_state = GetImageState(device_data, image);
1323 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1324 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1325 "VUID-vkGetImageSubresourceLayout-image-01895",
1326 "vkGetImageSubresourceLayout: Attempt to query layout from an image created with "
1327 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1328 "bound to memory.");
1329 }
1330 return skip;
1331}
1332
1333#else
1334
1335bool ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1336 const VkImageCreateInfo *create_info) {
1337 return false;
1338}
1339
1340void RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
1341
1342bool ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
1343
1344bool ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
1345
1346#endif // VK_USE_PLATFORM_ANDROID_KHR
1347
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001348bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001349 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001350 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001351 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1352
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001353 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1354 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1355 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1356 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1357 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1358 "VUID-VkImageCreateInfo-format-00943",
1359 "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED.");
1360 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001361 }
1362
Dave Houlton130c0212018-01-29 13:39:56 -07001363 const char *format_string = string_VkFormat(pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -07001364
1365 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
1366 std::stringstream ss;
1367 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 -06001368 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 -06001369 "VUID-VkImageCreateInfo-flags-00949", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001370 }
1371
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001372 VkImageFormatProperties format_limits = {};
1373 GetPDImageFormatProperties(device_data, pCreateInfo, &format_limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001374 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1375 std::stringstream ss;
1376 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001377 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06001378 "VUID-VkImageCreateInfo-mipLevels-02255", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001379 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001380
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001381 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001382 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1383 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1384 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
1385 std::stringstream ss;
1386 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
1387 "maxFramebufferWidth";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001388 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 -06001389 "VUID-VkImageCreateInfo-usage-00964", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001390 }
1391
1392 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
1393 std::stringstream ss;
1394 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
1395 "maxFramebufferHeight";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001396 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06001397 "VUID-VkImageCreateInfo-usage-00965", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -07001398 }
1399
1400 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1401 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1402 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
1403
1404 // Round up to imageGranularity boundary
1405 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
1406 uint64_t ig_mask = imageGranularity - 1;
1407 total_size = (total_size + ig_mask) & ~ig_mask;
1408
1409 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001410 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 -06001411 kVUID_Core_Image_InvalidFormatLimitsViolation,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001412 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1413 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -07001414 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001415 }
1416
Dave Houlton130c0212018-01-29 13:39:56 -07001417 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001418 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06001419 "VUID-VkImageCreateInfo-arrayLayers-02256",
Dave Houltond8ed0212018-05-16 17:18:24 -06001420 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d.", pCreateInfo->arrayLayers,
1421 format_limits.maxArrayLayers);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001422 }
1423
Dave Houlton130c0212018-01-29 13:39:56 -07001424 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001425 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Shannon McPhersona886c2a2018-10-12 14:38:20 -06001426 "VUID-VkImageCreateInfo-samples-02258", "CreateImage samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001427 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001428 }
1429
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06001430 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) &&
1431 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001432 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 -06001433 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001434 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1435 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001436 }
1437
Lenny Komowb79f04a2017-09-18 17:07:00 -06001438 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
1439 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1440 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1441 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1442 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001443 skip |=
1444 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1445 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1446 "format must be block, ETC or ASTC compressed, but is %s",
1447 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001448 }
1449 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1450 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001451 skip |=
1452 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1453 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1454 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001455 }
1456 }
1457 }
1458
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001459 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001460}
1461
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001462void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001463 IMAGE_LAYOUT_NODE image_state;
1464 image_state.layout = pCreateInfo->initialLayout;
1465 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001466 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
1467 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
1468 RecordCreateImageANDROID(pCreateInfo, is_node);
1469 }
1470 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001471 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -07001472 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1473 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001474}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001475
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001476bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001477 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001478 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +02001479 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001480 if (disabled->destroy_image) return false;
1481 bool skip = false;
1482 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06001483 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06001484 "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001485 }
1486 return skip;
1487}
1488
John Zulauffca05c12018-04-26 16:30:39 -06001489void PreCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001490 core_validation::InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001491 // Clean up memory mapping, bindings and range references for image
1492 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001493 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001494 if (mem_info) {
1495 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
1496 }
1497 }
Mark Lobodzinski33826372017-04-13 11:10:11 -06001498 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001499 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001500 // Remove image from imageMap
1501 core_validation::GetImageMap(device_data)->erase(image);
1502 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
1503 core_validation::GetImageSubresourceMap(device_data);
1504
1505 const auto &sub_entry = imageSubresourceMap->find(image);
1506 if (sub_entry != imageSubresourceMap->end()) {
1507 for (const auto &pair : sub_entry->second) {
1508 core_validation::GetImageLayoutMap(device_data)->erase(pair);
1509 }
1510 imageSubresourceMap->erase(sub_entry);
1511 }
1512}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001513
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001514bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001515 bool skip = false;
1516 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1517
1518 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1519 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1520 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 -06001521 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001522 }
1523
Dave Houlton1d2022c2017-03-29 11:43:58 -06001524 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001525 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1526 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 -06001527 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001528 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001529 char const str[] = "vkCmdClearColorImage called with compressed image.";
1530 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 -06001531 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001532 }
1533
1534 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1535 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1536 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 -06001537 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001538 }
1539 return skip;
1540}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001541
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001542uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1543 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1544 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001545 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001546 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001547 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001548 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001549}
1550
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001551uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1552 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1553 uint32_t array_layer_count = range->layerCount;
1554 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1555 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001556 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001557 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001558}
1559
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001560bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001561 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1562 bool skip = false;
1563 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1564
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001565 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1566 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001567
1568 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1569 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001570 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1571 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001572 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 -06001573 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001574 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1575 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001576 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001577 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001578 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001579 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 -06001580 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001581 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1582 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001583
1584 } else {
1585 if (image_state->shared_presentable) {
1586 skip |= log_msg(
1587 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001588 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001589 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1590 string_VkImageLayout(dest_image_layout));
1591 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001592 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001593 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001594 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001595 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001596 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001597 } else {
1598 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1599 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001600 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 -06001601 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001602 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1603 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001604 }
1605 }
1606
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001607 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1608 uint32_t level = level_index + range.baseMipLevel;
1609 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1610 uint32_t layer = layer_index + range.baseArrayLayer;
1611 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001612 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001613 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001614 if (node.layout != dest_image_layout) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001615 std::string error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001616 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001617 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001618 } else {
1619 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1620 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001621 skip |=
1622 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1623 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1624 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001625 }
1626 }
1627 }
1628 }
1629
1630 return skip;
1631}
1632
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001633void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1634 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001635 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1636 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1637 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001638
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001639 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1640 uint32_t level = level_index + range.baseMipLevel;
1641 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1642 uint32_t layer = layer_index + range.baseArrayLayer;
1643 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001644 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001645 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1646 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 -07001647 }
1648 }
1649 }
1650}
1651
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001652bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001653 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1654 bool skip = false;
1655 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001656 auto cb_node = GetCBNode(dev_data, commandBuffer);
1657 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001658 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001659 skip |=
1660 ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001661 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001662 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001663 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001664 if (GetApiVersion(dev_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001665 skip |=
1666 ValidateImageFormatFeatureFlags(dev_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001667 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001668 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001669 skip |= InsideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001670 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001671 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001672 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001673 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001674 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001675 }
1676 }
1677 return skip;
1678}
1679
1680// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001681void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001682 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001683 auto cb_node = GetCBNode(dev_data, commandBuffer);
1684 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001685 if (cb_node && image_state) {
1686 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001687 for (uint32_t i = 0; i < rangeCount; ++i) {
1688 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1689 }
1690 }
1691}
1692
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001693bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1694 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001695 const VkImageSubresourceRange *pRanges) {
1696 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001697 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1698
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001699 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001700 auto cb_node = GetCBNode(device_data, commandBuffer);
1701 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001702 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001703 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1704 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001705 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001706 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001707 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Cort Stratton186b1a22018-05-01 20:18:06 -04001708 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
1709 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001710 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1711 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001712 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001713 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001714 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001715 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001716 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001717 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001718 skip |=
1719 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001720 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001721 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1722 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001723 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001724 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1725 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001726 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 -06001727 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001728 }
1729 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001730 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001731 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001732 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 -06001733 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001734 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001735 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1736 char const str[] =
1737 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1738 "set.";
1739 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 -06001740 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001741 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001742 }
1743 return skip;
1744}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001745
1746// Returns true if [x, xoffset] and [y, yoffset] overlap
1747static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1748 bool result = false;
1749 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1750 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1751
1752 if (intersection_max > intersection_min) {
1753 result = true;
1754 }
1755 return result;
1756}
1757
Dave Houltonc991cc92018-03-06 11:08:51 -07001758// Returns true if source area of first copy region intersects dest area of second region
1759// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1760static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001761 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001762
Dave Houltonc991cc92018-03-06 11:08:51 -07001763 // Separate planes within a multiplane image cannot intersect
1764 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001765 return result;
1766 }
1767
Dave Houltonc991cc92018-03-06 11:08:51 -07001768 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1769 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1770 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001771 result = true;
1772 switch (type) {
1773 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001774 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001775 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001776 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001777 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001778 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001779 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001780 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001781 break;
1782 default:
1783 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1784 assert(false);
1785 }
1786 }
1787 return result;
1788}
1789
Dave Houltonfc1a4052017-04-27 14:32:45 -06001790// Returns non-zero if offset and extent exceed image extents
1791static const uint32_t x_bit = 1;
1792static const uint32_t y_bit = 2;
1793static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001794static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001795 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001796 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001797 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1798 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001799 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001800 }
1801 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1802 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001803 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001804 }
1805 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1806 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001807 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001808 }
1809 return result;
1810}
1811
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001812// Test if two VkExtent3D structs are equivalent
1813static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1814 bool result = true;
1815 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1816 (extent->depth != other_extent->depth)) {
1817 result = false;
1818 }
1819 return result;
1820}
1821
Dave Houltonee281a52017-12-08 13:51:02 -07001822// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1823// Destination image texel extents must be adjusted by block size for the dest validation checks
1824VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1825 VkExtent3D adjusted_extent = extent;
1826 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1827 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1828 adjusted_extent.width /= block_size.width;
1829 adjusted_extent.height /= block_size.height;
1830 adjusted_extent.depth /= block_size.depth;
1831 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1832 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1833 adjusted_extent.width *= block_size.width;
1834 adjusted_extent.height *= block_size.height;
1835 adjusted_extent.depth *= block_size.depth;
1836 }
1837 return adjusted_extent;
1838}
1839
Dave Houlton6f9059e2017-05-02 17:15:13 -06001840// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001841static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1842 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001843
1844 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001845 if (mip >= img->createInfo.mipLevels) {
1846 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001847 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001848
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001849 // 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 -06001850 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001851
1852 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1853 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001854 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001855 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1856 } else {
1857 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1858 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1859 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1860 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001861
Dave Houlton6f9059e2017-05-02 17:15:13 -06001862 // Image arrays have an effective z extent that isn't diminished by mip level
1863 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001864 extent.depth = img->createInfo.arrayLayers;
1865 }
1866
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001867 return extent;
1868}
1869
1870// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001871static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001872 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1873}
1874
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001875// Test if the extent argument has any dimensions set to 0.
1876static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1877 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1878}
1879
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001880// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1881static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1882 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1883 VkExtent3D granularity = {0, 0, 0};
1884 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1885 if (pPool) {
1886 granularity =
1887 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001888 if (FormatIsCompressed(img->createInfo.format)) {
1889 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001890 granularity.width *= block_size.width;
1891 granularity.height *= block_size.height;
1892 }
1893 }
1894 return granularity;
1895}
1896
1897// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1898static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1899 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001900 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1901 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001902 valid = false;
1903 }
1904 return valid;
1905}
1906
1907// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1908static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001909 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001910 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001911 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1912 bool skip = false;
1913 VkExtent3D offset_extent = {};
1914 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1915 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1916 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001917 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001918 // 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 -07001919 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001920 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 -04001921 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001922 "%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 "
1923 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001924 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001925 }
1926 } else {
1927 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1928 // integer multiples of the image transfer granularity.
1929 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001930 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 -04001931 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001932 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1933 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001934 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1935 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001936 }
1937 }
1938 return skip;
1939}
1940
1941// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1942static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1943 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001944 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
Dave Houltond8ed0212018-05-16 17:18:24 -06001945 std::string vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001946 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1947 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001948 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001949 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1950 // subresource extent.
1951 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001952 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 -04001953 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001954 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1955 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1956 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1957 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001958 }
1959 } else {
1960 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1961 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1962 // subresource extent dimensions.
1963 VkExtent3D offset_extent_sum = {};
1964 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1965 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1966 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001967 bool x_ok = true;
1968 bool y_ok = true;
1969 bool z_ok = true;
1970 switch (image_type) {
1971 case VK_IMAGE_TYPE_3D:
1972 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1973 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001974 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001975 case VK_IMAGE_TYPE_2D:
1976 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1977 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001978 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001979 case VK_IMAGE_TYPE_1D:
1980 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1981 (subresource_extent->width == offset_extent_sum.width));
1982 break;
1983 default:
1984 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1985 assert(false);
1986 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001987 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001988 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 -04001989 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001990 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1991 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1992 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1993 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1994 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1995 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001996 }
1997 }
1998 return skip;
1999}
2000
Cort Strattonff1542a2018-05-27 10:49:28 -07002001bool ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
2002 const uint32_t i, const char *function, const char *member, const std::string &vuid) {
2003 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2004 bool skip = false;
2005 if (mip_level >= img->createInfo.mipLevels) {
2006 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2007 HandleToUint64(cb_node->commandBuffer), vuid,
2008 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %" PRIx64 " has %u mip levels.", function, i,
2009 member, mip_level, HandleToUint64(img->image), img->createInfo.mipLevels);
2010 }
2011 return skip;
2012}
2013
2014bool ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2015 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i, const char *function,
2016 const char *member, const std::string &vuid) {
2017 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2018 bool skip = false;
2019 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2020 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2021 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2022 HandleToUint64(cb_node->commandBuffer), vuid,
2023 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2024 "%u, but provided image %" PRIx64 " has %u array layers.",
2025 function, i, member, base_layer, layer_count, HandleToUint64(img->image), img->createInfo.arrayLayers);
2026 }
2027 return skip;
2028}
2029
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002030// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002031bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2032 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Dave Houltone0969282018-05-23 15:54:31 -06002033 const uint32_t i, const char *function, const std::string &vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002034 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002035 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2036 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2037 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2038 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2039 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002040 return skip;
2041}
2042
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002043// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002044bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002045 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2046 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002047 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002048 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002049 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002050 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2051 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002052 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002053 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002054 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002055 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002056
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002057 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002058 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002059 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2060 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002061 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002062 const VkExtent3D dest_effective_extent =
2063 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002064 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002065 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002066 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002067 return skip;
2068}
2069
Dave Houlton6f9059e2017-05-02 17:15:13 -06002070// Validate contents of a VkImageCopy struct
2071bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
2072 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
2073 bool skip = false;
2074
2075 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002076 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002077
2078 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002079 const VkExtent3D src_copy_extent = region.extent;
2080 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002081 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2082
Dave Houlton6f9059e2017-05-02 17:15:13 -06002083 bool slice_override = false;
2084 uint32_t depth_slices = 0;
2085
2086 // Special case for copying between a 1D/2D array and a 3D image
2087 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2088 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002089 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002090 slice_override = (depth_slices != 1);
2091 } 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 -07002092 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002093 slice_override = (depth_slices != 1);
2094 }
2095
2096 // Do all checks on source image
2097 //
2098 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002099 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2100 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 -06002101 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002102 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002103 "be 0 and 1, respectively.",
2104 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002105 }
2106 }
2107
Dave Houlton533be9f2018-03-26 17:08:30 -06002108 // VUID-VkImageCopy-srcImage-01785
2109 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2110 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 -06002111 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002112 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002113 "these must be 0 and 1, respectively.",
2114 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002115 }
2116
Dave Houlton533be9f2018-03-26 17:08:30 -06002117 // VUID-VkImageCopy-srcImage-01787
2118 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2119 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002120 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002121 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2122 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002123 }
2124
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002125 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002126 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002127 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002128 skip |=
2129 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002130 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002131 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002132 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2133 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002134 }
2135 }
2136 } else { // Pre maint 1
2137 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002138 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002139 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 -06002140 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002141 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2142 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002143 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2144 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002145 }
2146 }
2147 }
2148
Dave Houltonc991cc92018-03-06 11:08:51 -07002149 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2150 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
2151 if (FormatIsCompressed(src_state->createInfo.format) ||
2152 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002153 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002154 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002155 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2156 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2157 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002158 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002159 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 -07002160 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002161 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002162 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002163 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002164 }
2165
Dave Houlton94a00372017-12-14 15:08:47 -07002166 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002167 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2168 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002169 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002170 skip |=
2171 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002172 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002173 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002174 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002175 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002176 }
2177
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002178 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002179 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2180 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002181 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002182 skip |=
2183 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002184 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002185 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002186 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002187 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002188 }
2189
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002190 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002191 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2192 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002193 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002194 skip |=
2195 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002196 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002197 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002198 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002199 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002200 }
2201 } // Compressed
2202
2203 // Do all checks on dest image
2204 //
2205 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002206 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002207 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 -06002208 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002209 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002210 "these must be 0 and 1, respectively.",
2211 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002212 }
2213 }
2214
Dave Houlton533be9f2018-03-26 17:08:30 -06002215 // VUID-VkImageCopy-dstImage-01786
2216 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2217 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 -06002218 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002219 "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 -06002220 "and 1, respectively.",
2221 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002222 }
2223
2224 // VUID-VkImageCopy-dstImage-01788
2225 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2226 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002227 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002228 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2229 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002230 }
2231
2232 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002233 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002234 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002235 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002236 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002237 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2238 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002239 }
2240 }
2241 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002242 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002243 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002244 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002245 skip |=
2246 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002247 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002248 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002249 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2250 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002251 }
2252 }
2253 } else { // Pre maint 1
2254 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002255 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002256 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 -06002257 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002258 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2259 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002260 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2261 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002262 }
2263 }
2264 }
2265
Dave Houltonc991cc92018-03-06 11:08:51 -07002266 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2267 if (FormatIsCompressed(dst_state->createInfo.format) ||
2268 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07002269 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270
2271 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002272 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2273 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2274 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002275 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002276 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 -07002277 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002278 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002279 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002280 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002281 }
2282
Dave Houlton94a00372017-12-14 15:08:47 -07002283 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002284 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2285 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002286 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002287 skip |=
2288 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002289 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002290 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002291 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002292 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002293 }
2294
Dave Houltonee281a52017-12-08 13:51:02 -07002295 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2296 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2297 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002298 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002299 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 -07002300 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002301 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2302 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002303 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002304 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002305 }
2306
Dave Houltonee281a52017-12-08 13:51:02 -07002307 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2308 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2309 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002310 std::string vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002311 skip |=
2312 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002313 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002314 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002315 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002316 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002317 }
2318 } // Compressed
2319 }
2320 return skip;
2321}
2322
Dave Houltonc991cc92018-03-06 11:08:51 -07002323// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
2324bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2325 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
2326 bool skip = false;
2327 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
2328
2329 // Neither image is multiplane
2330 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2331 // If neither image is multi-plane the aspectMask member of src and dst must match
2332 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2333 std::stringstream ss;
2334 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
2335 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2336 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 -06002337 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002338 }
2339 } else {
2340 // Source image multiplane checks
2341 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2342 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2343 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2344 std::stringstream ss;
2345 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2346 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 -06002347 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002348 }
2349 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2350 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2351 std::stringstream ss;
2352 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2353 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002354 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002355 }
2356 // Single-plane to multi-plane
2357 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2358 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2359 std::stringstream ss;
2360 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2361 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 -06002362 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002363 }
2364
2365 // Dest image multiplane checks
2366 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2367 aspect = region.dstSubresource.aspectMask;
2368 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2369 std::stringstream ss;
2370 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2371 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 -06002372 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002373 }
2374 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2375 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2376 std::stringstream ss;
2377 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2378 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002379 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002380 }
2381 // Multi-plane to single-plane
2382 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2383 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2384 std::stringstream ss;
2385 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2386 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 -06002387 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002388 }
2389 }
2390
2391 return skip;
2392}
2393
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002394bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002395 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2396 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002397 bool skip = false;
2398 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002399 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
2400
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002401 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2402
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002403 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002404 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002405
2406 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2407 VkExtent3D src_copy_extent = region.extent;
2408 VkExtent3D dst_copy_extent =
2409 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2410
Dave Houlton6f9059e2017-05-02 17:15:13 -06002411 bool slice_override = false;
2412 uint32_t depth_slices = 0;
2413
2414 // Special case for copying between a 1D/2D array and a 3D image
2415 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2416 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2417 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002418 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002419 slice_override = (depth_slices != 1);
2420 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2421 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002422 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002423 slice_override = (depth_slices != 1);
2424 }
2425
Cort Strattond619a302018-05-17 19:46:32 -07002426 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2427 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002428 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2429 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2430 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2431 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2432 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2433 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2434 "VUID-vkCmdCopyImage-srcSubresource-01698");
2435 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2436 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2437 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002438
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002439 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002440 // No chance of mismatch if we're overriding depth slice count
2441 if (!slice_override) {
2442 // The number of depth slices in srcSubresource and dstSubresource must match
2443 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2444 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002445 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2446 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002447 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002448 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2449 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002450 if (src_slices != dst_slices) {
2451 std::stringstream ss;
2452 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
2453 << "] do not match";
2454 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(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002456 }
2457 }
2458 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002459 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002460 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002461 std::stringstream ss;
2462 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
2463 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002464 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 -06002465 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002466 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002467 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002468
Dave Houltonc991cc92018-03-06 11:08:51 -07002469 // Do multiplane-specific checks, if extension enabled
2470 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2471 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2472 }
2473
Dave Houltonf5217612018-02-02 16:18:52 -07002474 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
2475 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2476 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2477 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
2478 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 -06002479 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002480 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002481 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002482
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002483 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002484 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002485 std::stringstream ss;
2486 ss << "vkCmdCopyImage: pRegion[" << i
2487 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2488 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 -06002489 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002490 }
2491
2492 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002493 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002494 std::stringstream ss;
2495 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2496 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 -06002497 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002498 }
2499
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002500 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2501 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2502 // 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 -07002503 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2504 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002505 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002506 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
2507 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2508 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2509 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002510 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 -06002511 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002512 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002513
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002514 // 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 -07002515 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2516 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002517 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002518 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2519 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2520 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2521 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002522 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 -06002523 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002524 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002525 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002526
Dave Houltonfc1a4052017-04-27 14:32:45 -06002527 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002528 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2529 if (slice_override) src_copy_extent.depth = depth_slices;
2530 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002531 if (extent_check & x_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(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002534 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002535 "width [%1d].",
2536 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002537 }
2538
2539 if (extent_check & y_bit) {
2540 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002541 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002542 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002543 "height [%1d].",
2544 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002545 }
2546 if (extent_check & z_bit) {
2547 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 -06002548 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002549 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002550 "depth [%1d].",
2551 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002552 }
2553
Dave Houltonee281a52017-12-08 13:51:02 -07002554 // Adjust dest extent if necessary
2555 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2556 if (slice_override) dst_copy_extent.depth = depth_slices;
2557
2558 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002559 if (extent_check & x_bit) {
2560 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 -06002561 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002562 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002563 "width [%1d].",
2564 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002565 }
2566 if (extent_check & y_bit) {
2567 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 -06002568 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002569 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002570 "height [%1d].",
2571 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002572 }
2573 if (extent_check & z_bit) {
2574 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 -06002575 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002576 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002577 "depth [%1d].",
2578 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002579 }
2580
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002581 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2582 // must not overlap in memory
2583 if (src_image_state->image == dst_image_state->image) {
2584 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002585 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2586 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002587 std::stringstream ss;
2588 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2589 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 -06002590 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002591 }
2592 }
2593 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002594 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002595
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002596 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2597 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2598 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002599 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002600 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2601 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002602 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 -06002603 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002604 }
2605 } else {
Tony-LunarG7482ca92018-10-01 14:20:22 -06002606 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, region_count, regions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002607 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2608 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002609 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002610 }
2611 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002612
Dave Houlton33c22b72017-02-28 13:16:02 -07002613 // Source and dest image sample counts must match
2614 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2615 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2616 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 -06002617 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002618 }
2619
Dave Houltond8ed0212018-05-16 17:18:24 -06002620 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2621 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002622 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002623 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2624 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2625 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2626 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04002627 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002628 skip |=
2629 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002630 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002631 skip |=
2632 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002633 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002634 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002635 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002636 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2637 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002638 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002639 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002640 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07002641 const std::string invalid_src_layout_vuid =
2642 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2643 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2644 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2645 const std::string invalid_dst_layout_vuid =
2646 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2647 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2648 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002649 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002650 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002651 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2652 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002653 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07002654 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2655 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002656 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2657 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002658 }
2659
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002660 return skip;
2661}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002662
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002663void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002664 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2665 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2666 // Make sure that all image slices are updated to correct layout
2667 for (uint32_t i = 0; i < region_count; ++i) {
2668 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2669 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2670 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002671 // Update bindings between images and cmd buffer
2672 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2673 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002674}
2675
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002676// Returns true if sub_rect is entirely contained within rect
2677static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2678 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2679 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2680 return false;
2681 return true;
2682}
2683
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002684bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2685 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002686 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002687 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2688
2689 bool skip = false;
2690 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002691 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002692 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002693 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002694 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002695 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002696 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2697 // 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 -07002698 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2699 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002700 skip |= log_msg(
2701 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002702 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002703 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2704 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2705 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002706 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002707 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002708 }
2709
2710 // Validate that attachment is in reference list of active subpass
2711 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002712 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2713 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002714 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002715
2716 for (uint32_t i = 0; i < attachmentCount; i++) {
2717 auto clear_desc = &pAttachments[i];
2718 VkImageView image_view = VK_NULL_HANDLE;
2719
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002720 if (0 == clear_desc->aspectMask) {
2721 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 -06002722 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002723 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2724 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 -06002725 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002726 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002727 if ((subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment != VK_ATTACHMENT_UNUSED) &&
2728 (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002729 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Shannon McPherson23a14fd2018-11-12 10:56:02 -07002730 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2731 "vkCmdClearAttachments() color attachment index %d is not VK_ATTACHMENT_UNUSED and is out of "
2732 "range for active subpass %d.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002733 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002734 } else {
2735 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002736 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002737 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002738 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2739 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2740 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002741 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002742 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 -06002743 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002744 }
2745 } else { // Must be depth and/or stencil
2746 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2747 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002748 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002749 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 -06002750 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002751 }
2752 if (!subpass_desc->pDepthStencilAttachment ||
2753 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2754 skip |= log_msg(
2755 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002756 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002757 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002758 } else {
2759 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2760 }
2761 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002762 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002763 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002764 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002765 // The rectangular region specified by a given element of pRects must be contained within the render area of
2766 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002767 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2768 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2769 skip |=
2770 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002771 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002772 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002773 "the current render pass instance.",
2774 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002775 }
2776 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002777 const auto local_rect =
2778 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002779 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002780 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002781 return log_msg(
2782 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002783 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00016",
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002784 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002785 "the current render pass instance.",
2786 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002787 }
2788 return false;
2789 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002790 }
2791 // The layers specified by a given element of pRects must be contained within every attachment that
2792 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002793 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002794 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2795 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002796 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 -06002797 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-pRects-00017",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002798 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002799 "of pAttachment[%d].",
2800 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002801 }
2802 }
2803 }
2804 }
2805 }
2806 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002807}
2808
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002809bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Cort Stratton7df30962018-05-17 19:45:57 -07002810 VkImageLayout src_image_layout, IMAGE_STATE *dst_image_state, VkImageLayout dst_image_layout,
2811 uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002812 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002813 bool skip = false;
2814 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002815 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2816 "VUID-vkCmdResolveImage-srcImage-00256");
2817 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2818 "VUID-vkCmdResolveImage-dstImage-00258");
2819 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2820 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002821 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002822 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002823 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002824 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2825 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002826
Cort Stratton7df30962018-05-17 19:45:57 -07002827 bool hit_error = false;
2828 const std::string invalid_src_layout_vuid =
2829 (src_image_state->shared_presentable &&
2830 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2831 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2832 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2833 const std::string invalid_dst_layout_vuid =
2834 (dst_image_state->shared_presentable &&
2835 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
2836 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2837 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002838 // For each region, the number of layers in the image subresource should not be zero
2839 // For each region, src and dest image aspect must be color only
2840 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002841 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2842 "srcSubresource", i);
2843 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2844 "dstSubresource", i);
Cort Stratton7df30962018-05-17 19:45:57 -07002845 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, src_image_layout,
2846 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2847 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
2848 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dst_image_layout,
2849 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2850 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002851 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2852 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2853 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2854 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2855 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2856 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2857 "VUID-vkCmdResolveImage-srcSubresource-01711");
2858 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2859 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2860 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002861
2862 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002863 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2864 skip |= log_msg(
2865 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-VkImageResolve-layerCount-00267",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002867 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002868 }
Cort Stratton7df30962018-05-17 19:45:57 -07002869 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002870 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2871 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2872 char const str[] =
2873 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2874 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 -06002875 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002876 }
2877 }
2878
2879 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2880 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002881 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 -06002882 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002883 }
2884 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2885 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002886 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 -06002887 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002888 }
2889 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2890 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2891 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002892 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002893 }
2894 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2895 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2896 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 -06002897 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002898 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002899 } else {
2900 assert(0);
2901 }
2902 return skip;
2903}
2904
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002905void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2906 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002907 // Update bindings between images and cmd buffer
2908 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2909 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002910}
2911
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002912bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002913 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2914 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002915 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2916
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002917 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002918 if (cb_node) {
2919 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2920 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002921 if (cb_node && src_image_state && dst_image_state) {
2922 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002923 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002924 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002925 "VUID-vkCmdBlitImage-dstImage-00234");
2926 skip |=
2927 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2928 skip |=
2929 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
2930 skip |=
2931 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2932 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2933 skip |=
2934 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2935 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2936 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
2937 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002938 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002939 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002940 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002941 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04002942 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002943 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002944
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002945 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002946
Dave Houlton33c2d252017-06-09 17:08:32 -06002947 VkFormat src_format = src_image_state->createInfo.format;
2948 VkFormat dst_format = dst_image_state->createInfo.format;
2949 VkImageType src_type = src_image_state->createInfo.imageType;
2950 VkImageType dst_type = dst_image_state->createInfo.imageType;
2951
Cort Stratton186b1a22018-05-01 20:18:06 -04002952 if (VK_FILTER_LINEAR == filter) {
2953 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002954 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2955 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002956 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002957 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
2958 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002959 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002960 }
2961
2962 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2963 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 -06002964 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002965 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002966 }
2967
Dave Houlton33c2d252017-06-09 17:08:32 -06002968 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2969 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2970 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 -06002971 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002972 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002973 }
2974
2975 // Validate consistency for unsigned formats
2976 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2977 std::stringstream ss;
2978 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2979 << "the other one must also have unsigned integer format. "
2980 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2981 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 -06002982 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002983 }
2984
2985 // Validate consistency for signed formats
2986 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2987 std::stringstream ss;
2988 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2989 << "the other one must also have signed integer format. "
2990 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2991 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 -06002992 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002993 }
2994
2995 // Validate filter for Depth/Stencil formats
2996 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2997 std::stringstream ss;
2998 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2999 << "then filter must be VK_FILTER_NEAREST.";
3000 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003001 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003002 }
3003
3004 // Validate aspect bits and formats for depth/stencil images
3005 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3006 if (src_format != dst_format) {
3007 std::stringstream ss;
3008 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
3009 << "stencil, the other one must have exactly the same format. "
3010 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3011 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003012 skip |=
3013 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3014 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003015 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003016 } // Depth or Stencil
3017
3018 // Do per-region checks
Cort Stratton7df30962018-05-17 19:45:57 -07003019 const std::string invalid_src_layout_vuid =
3020 (src_image_state->shared_presentable &&
3021 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3022 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3023 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3024 const std::string invalid_dst_layout_vuid =
3025 (dst_image_state->shared_presentable &&
3026 core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
3027 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3028 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003029 for (uint32_t i = 0; i < region_count; i++) {
3030 const VkImageBlit rgn = regions[i];
3031 bool hit_error = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06003032 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003033 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3034 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Dave Houltond8ed0212018-05-16 17:18:24 -06003035 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
Cort Stratton7df30962018-05-17 19:45:57 -07003036 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3037 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003038 skip |=
3039 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3040 skip |=
3041 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003042 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3043 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3044 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3045 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3046 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3047 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3048 "VUID-vkCmdBlitImage-srcSubresource-01707");
3049 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3050 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3051 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003052 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003053 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3054 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003055 std::stringstream ss;
3056 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003057 skip |=
3058 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3059 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003060 }
Dave Houlton48989f32017-05-26 15:01:46 -06003061 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3062 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003063 std::stringstream ss;
3064 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003065 skip |=
3066 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3067 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003068 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003069
3070 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003071 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003072 skip |=
3073 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003074 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003075 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003076 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003077
Dave Houlton48989f32017-05-26 15:01:46 -06003078 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003079 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 -06003080 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003081 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003082 }
Dave Houlton48989f32017-05-26 15:01:46 -06003083
Dave Houlton33c2d252017-06-09 17:08:32 -06003084 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3085 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 -06003086 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Dave Houlton33c2d252017-06-09 17:08:32 -06003087 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003088 "image format %s.",
3089 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003090 }
3091
3092 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3093 skip |= log_msg(
3094 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003095 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003096 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
3097 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003098 }
3099
Dave Houlton48989f32017-05-26 15:01:46 -06003100 // Validate source image offsets
3101 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003102 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003103 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
3104 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003105 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
Dave Houlton48989f32017-05-26 15:01:46 -06003106 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003107 "of (%1d, %1d). These must be (0, 1).",
3108 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003109 }
3110 }
3111
Dave Houlton33c2d252017-06-09 17:08:32 -06003112 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003113 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3114 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 -06003115 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Dave Houlton48989f32017-05-26 15:01:46 -06003116 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003117 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3118 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003119 }
3120 }
3121
Dave Houlton33c2d252017-06-09 17:08:32 -06003122 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003123 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3124 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003125 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003126 skip |=
3127 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003128 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003129 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3130 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003131 }
3132 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3133 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003134 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003135 skip |= log_msg(
3136 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003137 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003138 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
3139 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003140 }
3141 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3142 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003143 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003144 skip |=
3145 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003146 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003147 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3148 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003149 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003150 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003151 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 -06003152 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003153 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003154 }
Dave Houlton48989f32017-05-26 15:01:46 -06003155
3156 // Validate dest image offsets
3157 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003158 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003159 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
3160 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 -06003161 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
Dave Houlton48989f32017-05-26 15:01:46 -06003162 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003163 "(%1d, %1d). These must be (0, 1).",
3164 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003165 }
3166 }
3167
Dave Houlton33c2d252017-06-09 17:08:32 -06003168 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003169 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3170 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003171 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Dave Houlton48989f32017-05-26 15:01:46 -06003172 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003173 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3174 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003175 }
3176 }
3177
Dave Houlton33c2d252017-06-09 17:08:32 -06003178 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003179 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3180 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003181 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003182 skip |=
3183 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003184 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003185 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
3186 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003187 }
3188 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3189 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003190 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003191 skip |= log_msg(
3192 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003193 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003194 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
3195 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003196 }
3197 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3198 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003199 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003200 skip |=
3201 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003202 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003203 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
3204 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003205 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003206 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003207 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 -06003208 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003209 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003210 }
3211
Dave Houlton33c2d252017-06-09 17:08:32 -06003212 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3213 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3214 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
3215 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 -06003216 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
Dave Houlton33c2d252017-06-09 17:08:32 -06003217 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003218 "layerCount other than 1.",
3219 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003220 }
3221 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003222 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003223 } else {
3224 assert(0);
3225 }
3226 return skip;
3227}
3228
Tobin Ehlis58c884f2017-02-08 12:15:27 -07003229void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003230 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
3231 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
3232 // Make sure that all image slices are updated to correct layout
3233 for (uint32_t i = 0; i < region_count; ++i) {
3234 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
3235 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
3236 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003237 // Update bindings between images and cmd buffer
3238 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3239 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003240}
3241
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003242// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07003243bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003244 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3245 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003246 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07003247 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003248 for (auto cb_image_data : pCB->imageLayoutMap) {
3249 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003250
Dave Houltonb3f4b282018-02-22 16:25:16 -07003251 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3252 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003253 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3254 // TODO: Set memory invalid which is in mem_tracker currently
3255 } else if (imageLayout != cb_image_data.second.initialLayout) {
3256 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003257 skip |= log_msg(
3258 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003259 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003260 "Submitted command buffer expects image 0x%" PRIx64
3261 " (subresource: aspectMask 0x%X array layer %u, mip level %u) to be in layout %s--instead, image 0x%" PRIx64
3262 "'s current layout is %s.",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003263 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
3264 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003265 string_VkImageLayout(cb_image_data.second.initialLayout), HandleToUint64(cb_image_data.first.image),
3266 string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003267 } else {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003268 skip |=
3269 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3270 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3271 "Submitted command buffer expects image 0x%" PRIx64 " to be in layout %s--instead, image 0x%" PRIx64
3272 "'s current layout is %s.",
3273 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(cb_image_data.second.initialLayout),
3274 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003275 }
3276 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003277 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003278 }
3279 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003280 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003281}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003282
Tony Barbourdf013b92017-01-25 12:53:48 -07003283void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
3284 for (auto cb_image_data : pCB->imageLayoutMap) {
3285 VkImageLayout imageLayout;
3286 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3287 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3288 }
3289}
3290
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003291// Print readable FlagBits in FlagMask
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003292static std::string StringVkAccessFlags(VkAccessFlags accessMask) {
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003293 std::string result;
3294 std::string separator;
3295
3296 if (accessMask == 0) {
3297 result = "[None]";
3298 } else {
3299 result = "[";
3300 for (auto i = 0; i < 32; i++) {
3301 if (accessMask & (1 << i)) {
3302 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
3303 separator = " | ";
3304 }
3305 }
3306 result = result + "]";
3307 }
3308 return result;
3309}
3310
Dave Houlton12befb92018-06-26 17:16:46 -06003311#if 0 // This fxn seems vestigial, not called anywhere. All VkAccessFlagBits VUIDs are implicit & being checked by parameter
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003312 // validation ToBeRemoved (disabled 6/18)
Dave Houlton12befb92018-06-26 17:16:46 -06003313
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003314// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
3315// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003316// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003317static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
3318 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
3319 const char *type) {
3320 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3321 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003322
3323 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
3324 if (accessMask & ~(required_bit | optional_bits)) {
3325 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003326 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 -06003327 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003328 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003329 StringVkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003330 }
3331 } else {
3332 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003333 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 -06003334 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003335 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
3336 "has previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003337 type, accessMask, StringVkAccessFlags(accessMask).c_str(), optional_bits,
3338 StringVkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003339 } else {
3340 std::string opt_bits;
3341 if (optional_bits != 0) {
3342 std::stringstream ss;
3343 ss << optional_bits;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003344 opt_bits = "and may have optional bits " + ss.str() + ' ' + StringVkAccessFlags(optional_bits);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003345 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003346 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 -06003347 HandleToUint64(cmdBuffer), kVUID_Core_DrawState_InvalidBarrier,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003348 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
3349 "previously added a barrier for this transition.",
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003350 type, accessMask, StringVkAccessFlags(accessMask).c_str(), required_bit,
3351 StringVkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003352 }
3353 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07003354 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003355}
Dave Houlton12befb92018-06-26 17:16:46 -06003356#endif
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003357
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003358// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003359// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3360// layout attachments don't have CLEAR as their loadOp.
Tobias Hectorbbb12282018-10-22 15:17:59 +01003361bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3362 const VkImageLayout first_layout, const uint32_t attachment,
3363 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003364 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003365 const char *vuid;
3366 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3367
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003368 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3369 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3370 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3371 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003372 vuid =
3373 use_rp2 ? "VUID-VkRenderPassCreateInfo2KHR-pAttachments-03053" : "VUID-VkRenderPassCreateInfo-pAttachments-00836";
Dave Houltond8ed0212018-05-16 17:18:24 -06003374 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003375 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003376 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003377 }
3378 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003379 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3380 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003381 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003382 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003383 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003384 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003385 }
3386 }
3387
3388 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3389 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003390 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003391 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003392 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003393 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003394 }
3395 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003396 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003397}
3398
Tobias Hectorbbb12282018-10-22 15:17:59 +01003399bool ValidateLayouts(const core_validation::layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3400 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003401 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003402 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003403 const char *vuid;
3404 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3405 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003406
Jason Ekstranda1906302017-12-03 20:16:32 -08003407 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3408 VkFormat format = pCreateInfo->pAttachments[i].format;
3409 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3410 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3411 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003412 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 -06003413 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003414 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3415 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3416 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3417 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003418 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003419 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003420 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 -06003421 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003422 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3423 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3424 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3425 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003426 }
3427 }
3428 }
3429
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003430 // Track when we're observing the first use of an attachment
3431 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3432 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003433 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003434
3435 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3436 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3437 auto attach_index = subpass.pInputAttachments[j].attachment;
3438 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003439 switch (subpass.pInputAttachments[j].layout) {
3440 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3441 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3442 // These are ideal.
3443 break;
3444
3445 case VK_IMAGE_LAYOUT_GENERAL:
3446 // May not be optimal. TODO: reconsider this warning based on other constraints.
3447 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003448 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003449 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3450 break;
3451
Tobias Hectorbbb12282018-10-22 15:17:59 +01003452 case VK_IMAGE_LAYOUT_UNDEFINED:
3453 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3454 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3455 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3456 "Layout for input attachment reference %u in subpass %u is %s but must be "
3457 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3458 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3459 break;
3460
Graeme Leese668a9862018-10-08 10:40:02 +01003461 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3462 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3463 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3464 break;
3465 } else {
3466 // Intentionally fall through to generic error message
3467 }
3468 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003469
Cort Stratton7547f772017-05-04 15:18:52 -07003470 default:
3471 // No other layouts are acceptable
3472 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 -06003473 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003474 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3475 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3476 }
3477
Cort Stratton7547f772017-05-04 15:18:52 -07003478 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003479 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3480 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003481
3482 bool used_as_depth =
3483 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3484 bool used_as_color = false;
3485 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3486 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3487 }
3488 if (!used_as_depth && !used_as_color &&
3489 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003490 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3491 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3492 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3493 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003494 }
3495 }
3496 attach_first_use[attach_index] = false;
3497 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003498
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003499 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3500 auto attach_index = subpass.pColorAttachments[j].attachment;
3501 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3502
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003503 // TODO: Need a way to validate shared presentable images here, currently just allowing
3504 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3505 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003506 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003507 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003508 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003509 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3510 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003511 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003512
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003513 case VK_IMAGE_LAYOUT_GENERAL:
3514 // May not be optimal; TODO: reconsider this warning based on other constraints?
3515 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003516 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003517 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3518 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003519
Tobias Hectorbbb12282018-10-22 15:17:59 +01003520 case VK_IMAGE_LAYOUT_UNDEFINED:
3521 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3522 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3523 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3524 "Layout for color attachment reference %u in subpass %u is %s but should be "
3525 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3526 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3527 break;
3528
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003529 default:
3530 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 -06003531 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003532 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3533 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003534 }
3535
Tobias Hectorbbb12282018-10-22 15:17:59 +01003536 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3537 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
3538 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3539 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3540 "Layout for color attachment reference %u in subpass %u is %s but should be "
3541 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3542 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3543 }
3544
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003545 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003546 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3547 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003548 }
3549 attach_first_use[attach_index] = false;
3550 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003551
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003552 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3553 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003554 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3555 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3556 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003557 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003558
Dave Houltona9df0ce2018-02-07 10:51:23 -07003559 case VK_IMAGE_LAYOUT_GENERAL:
3560 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3561 // doing a bunch of transitions.
3562 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003563 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003564 "GENERAL layout for depth attachment may not give optimal performance.");
3565 break;
3566
Tobias Hectorbbb12282018-10-22 15:17:59 +01003567 case VK_IMAGE_LAYOUT_UNDEFINED:
3568 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3569 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3570 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3571 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3572 "layout or GENERAL.",
3573 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3574 break;
3575
Dave Houltona9df0ce2018-02-07 10:51:23 -07003576 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3577 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3578 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3579 break;
3580 } else {
3581 // Intentionally fall through to generic error message
3582 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003583 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003584
Dave Houltona9df0ce2018-02-07 10:51:23 -07003585 default:
3586 // No other layouts are acceptable
3587 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 -06003588 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003589 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3590 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3591 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003592 }
3593
3594 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3595 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003596 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3597 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003598 }
3599 attach_first_use[attach_index] = false;
3600 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003601 }
3602 return skip;
3603}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003604
3605// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003606bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3607 VkDeviceSize offset, VkDeviceSize end_offset) {
3608 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3609 bool skip = false;
3610 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3611 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003612 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3613 for (auto image_handle : mem_info->bound_images) {
3614 auto img_it = mem_info->bound_ranges.find(image_handle);
3615 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003616 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003617 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003618 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003619 for (auto layout : layouts) {
3620 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003621 skip |=
3622 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 -06003623 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003624 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3625 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003626 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003627 }
3628 }
3629 }
3630 }
3631 }
3632 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003633 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003634}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003635
3636// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3637// is true, verify that (actual & desired) flags == desired
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003638static bool ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3639 VulkanObjectType obj_type, std::string msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003640 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003641
3642 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003643 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003644 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003645 if (strict) {
3646 correct_usage = ((actual & desired) == desired);
3647 } else {
3648 correct_usage = ((actual & desired) != 0);
3649 }
3650 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003651 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003652 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003653 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003654 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 -06003655 kVUID_Core_MemTrack_InvalidUsageFlag,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003656 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3657 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003658 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003659 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003660 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 -06003661 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3662 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003663 }
3664 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003665 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003666}
3667
3668// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3669// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003670bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003671 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003672 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3673 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003674}
3675
Cort Stratton186b1a22018-05-01 20:18:06 -04003676bool ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Dave Houltone0969282018-05-23 15:54:31 -06003677 char const *func_name, const std::string &linear_vuid, const std::string &optimal_vuid) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003678 VkFormatProperties format_properties = GetPDFormatProperties(dev_data, image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003679 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3680 bool skip = false;
3681 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3682 if ((format_properties.linearTilingFeatures & desired) != desired) {
3683 skip |=
3684 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3685 HandleToUint64(image_state->image), linear_vuid,
3686 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3687 format_properties.linearTilingFeatures, image_state->createInfo.format, HandleToUint64(image_state->image));
3688 }
3689 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3690 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3691 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3692 HandleToUint64(image_state->image), optimal_vuid,
3693 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %" PRIx64 ".", func_name,
3694 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3695 HandleToUint64(image_state->image));
3696 }
3697 }
3698 return skip;
3699}
3700
Cort Strattond619a302018-05-17 19:46:32 -07003701bool ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3702 const VkImageSubresourceLayers *subresource_layers, char const *func_name, char const *member,
3703 uint32_t i) {
3704 bool skip = false;
3705 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
3706 // layerCount must not be zero
3707 if (subresource_layers->layerCount == 0) {
3708 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3709 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3710 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3711 }
3712 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3713 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3714 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3715 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3716 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3717 }
3718 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3719 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3720 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3721 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3722 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3723 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3724 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3725 func_name, i, member);
3726 }
3727 return skip;
3728}
3729
Mark Lobodzinski96210742017-02-09 10:33:46 -07003730// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3731// where an error will be flagged if usage is not correct
Shannon McPhersona84241a2018-06-18 15:34:46 -06003732bool ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Dave Houltone0969282018-05-23 15:54:31 -06003733 const std::string &msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003734 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3735 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003736}
3737
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003738bool ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3739 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
3740 bool skip = false;
3741 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3742
3743 const VkDeviceSize &range = pCreateInfo->range;
3744 if (range != VK_WHOLE_SIZE) {
3745 // Range must be greater than 0
3746 if (range <= 0) {
3747 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3748 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3749 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3750 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3751 range);
3752 }
3753 // Range must be a multiple of the element size of format
3754 const size_t format_size = FormatSize(pCreateInfo->format);
3755 if (range % format_size != 0) {
3756 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3757 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3758 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3759 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3760 "(" PRINTF_SIZE_T_SPECIFIER ").",
3761 range, format_size);
3762 }
3763 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3764 if (range / format_size > device_limits->maxTexelBufferElements) {
3765 skip |=
3766 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3767 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3768 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3769 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3770 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3771 range, format_size, device_limits->maxTexelBufferElements);
3772 }
3773 // The sum of range and offset must be less than or equal to the size of buffer
3774 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3775 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3776 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3777 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3778 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3779 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3780 range, pCreateInfo->offset, buffer_state->createInfo.size);
3781 }
3782 }
3783 return skip;
3784}
3785
Shannon McPherson265383a2018-06-21 15:37:52 -06003786bool ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3787 const VkBufferViewCreateInfo *pCreateInfo) {
3788 bool skip = false;
3789 const debug_report_data *report_data = GetReportData(device_data);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06003790 const VkFormatProperties format_properties = GetPDFormatProperties(device_data, pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003791 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3792 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3793 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3794 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3795 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3796 "be supported for uniform texel buffers");
3797 }
3798 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3799 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3801 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3802 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3803 "be supported for storage texel buffers");
3804 }
3805 return skip;
3806}
3807
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003808bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003809 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003810 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3811
Dave Houltond8ed0212018-05-16 17:18:24 -06003812 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003813
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003814 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003815 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 -06003816 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003817 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003818 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003819 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003820
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003821 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) &&
3822 (!GetEnabledFeatures(device_data)->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003823 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 -06003824 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003825 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003826 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003827 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003828
Mike Schuchardtbdf74bb2018-07-18 14:29:02 -06003829 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) &&
3830 (!GetEnabledFeatures(device_data)->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003831 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 -06003832 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003833 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003834 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003835 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003836 return skip;
3837}
3838
3839void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3840 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3841 GetBufferMap(device_data)
3842 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3843}
3844
Shannon McPhersona84241a2018-06-18 15:34:46 -06003845bool PreCallValidateCreateBufferView(const layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003846 bool skip = false;
Shannon McPherson883f6092018-06-14 13:15:25 -06003847 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003848 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003849 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3850 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003851 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3852 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003853 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3854 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003855 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3856 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3857 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3858 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003859
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003860 // Buffer view offset must be less than the size of buffer
3861 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3862 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3863 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3864 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3865 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3866 pCreateInfo->offset, buffer_state->createInfo.size);
3867 }
3868
Shannon McPherson883f6092018-06-14 13:15:25 -06003869 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
3870 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3871 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3872 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3873 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3874 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3875 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3876 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3877 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003878
3879 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003880
3881 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003882 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003883 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003884}
3885
3886void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3887 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3888}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003889
3890// For the given format verify that the aspect masks make sense
Tobias Hectorbbb12282018-10-22 15:17:59 +01003891bool ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3892 const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003893 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3894 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003895 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3896 if (image != VK_NULL_HANDLE) {
3897 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3898 }
3899
Dave Houlton1d2022c2017-03-29 11:43:58 -06003900 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003901 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003902 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003903 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003904 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003905 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003906 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003907 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003908 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003909 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003910 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003911 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003912 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3913 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003914 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003915 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003916 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003917 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3918 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003919 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003920 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003921 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003922 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003923 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003924 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003925 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003926 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003927 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003928 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003929 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003930 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003931 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003932 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003933 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003934 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003935 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003936 } else if (FormatIsMultiplane(format)) {
3937 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3938 if (3 == FormatPlaneCount(format)) {
3939 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3940 }
3941 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003942 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003943 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3944 "set, where n = [0, 1, 2].",
3945 func_name);
3946 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003947 }
3948 return skip;
3949}
3950
Petr Krausffa94af2017-08-08 21:46:02 +02003951struct SubresourceRangeErrorCodes {
Dave Houltond8ed0212018-05-16 17:18:24 -06003952 std::string base_mip_err, mip_count_err, base_layer_err, layer_count_err;
Petr Krausffa94af2017-08-08 21:46:02 +02003953};
3954
3955bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3956 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3957 const char *image_layer_count_var_name, const uint64_t image_handle,
3958 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003959 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3960 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003961
3962 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003963 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003964 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 -06003965 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003966 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003967 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3968 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003969 }
Petr Kraus4d718682017-05-18 03:38:41 +02003970
Petr Krausffa94af2017-08-08 21:46:02 +02003971 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3972 if (subresourceRange.levelCount == 0) {
3973 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 -06003974 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003975 } else {
3976 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003977
Petr Krausffa94af2017-08-08 21:46:02 +02003978 if (necessary_mip_count > image_mip_count) {
3979 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 -06003980 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003981 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003982 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003983 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003984 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003985 }
Petr Kraus4d718682017-05-18 03:38:41 +02003986 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003987 }
Petr Kraus4d718682017-05-18 03:38:41 +02003988
3989 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003990 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003991 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 -06003992 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003993 "%s: %s.baseArrayLayer (= %" PRIu32
3994 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3995 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003996 }
Petr Kraus4d718682017-05-18 03:38:41 +02003997
Petr Krausffa94af2017-08-08 21:46:02 +02003998 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3999 if (subresourceRange.layerCount == 0) {
4000 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 -06004001 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004002 } else {
4003 const uint64_t necessary_layer_count =
4004 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004005
Petr Krausffa94af2017-08-08 21:46:02 +02004006 if (necessary_layer_count > image_layer_count) {
4007 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 -06004008 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004009 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004010 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004011 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004012 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004013 }
Petr Kraus4d718682017-05-18 03:38:41 +02004014 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004015 }
Petr Kraus4d718682017-05-18 03:38:41 +02004016
Mark Lobodzinski602de982017-02-09 11:01:33 -07004017 return skip;
4018}
4019
Petr Krausffa94af2017-08-08 21:46:02 +02004020bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4021 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
4022 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
4023 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4024 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4025 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4026
4027 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4028 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4029
4030 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004031 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4032 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4033 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4034 : "VUID-VkImageViewCreateInfo-image-01482")
4035 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4036 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4037 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4038 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4039 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004040
4041 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4042 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4043 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4044}
4045
4046bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4047 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4048 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004049 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4050 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4051 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4052 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004053
4054 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4055 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4056 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4057}
4058
4059bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4060 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
4061 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004062 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4063 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4064 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4065 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004066
4067 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4068 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4069 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4070}
4071
4072bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4073 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4074 const char *param_name) {
4075 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004076 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4077 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4078 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4079 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004080
4081 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4082 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4083 subresourceRangeErrorCodes);
4084}
4085
Mark Lobodzinski602de982017-02-09 11:01:33 -07004086bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
4087 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4088 bool skip = false;
4089 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
4090 if (image_state) {
4091 skip |= ValidateImageUsageFlags(
4092 device_data, image_state,
4093 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004094 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4095 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004096 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004097 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004098 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004099 skip |=
4100 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004101 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004102 skip |= ValidateCreateImageViewSubresourceRange(
4103 device_data, image_state,
4104 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4105 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004106
4107 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4108 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004109 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4110 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004111 VkFormat view_format = create_info->format;
4112 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004113 VkImageType image_type = image_state->createInfo.imageType;
4114 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004115
Dave Houltonbd2e2622018-04-10 16:41:14 -06004116 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
4117 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
4118 if (chained_ivuci_struct) {
4119 if (chained_ivuci_struct->usage & ~image_usage) {
4120 std::stringstream ss;
4121 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004122 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004123 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004124 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4125 HandleToUint64(create_info->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
4126 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004127 }
4128
4129 image_usage = chained_ivuci_struct->usage;
4130 }
4131
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004132 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4133 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004134 if (FormatIsMultiplane(image_format)) {
4135 // View format must match the multiplane compatible format
4136 uint32_t plane = 3; // invalid
4137 switch (aspect_mask) {
4138 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4139 plane = 0;
4140 break;
4141 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4142 plane = 1;
4143 break;
4144 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4145 plane = 2;
4146 break;
4147 default:
4148 break;
4149 }
4150
4151 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4152 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004153 std::stringstream ss;
4154 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004155 << " is not compatible with plane " << plane << " of underlying image format "
4156 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004157 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4158 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
4159 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004160 }
4161 } else {
4162 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
4163 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4164 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4165 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4166 std::stringstream ss;
4167 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
4168 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
4169 << ") format " << string_VkFormat(image_format)
4170 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4171 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004172 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4173 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
4174 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004175 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004176 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004177 }
4178 } else {
4179 // Format MUST be IDENTICAL to the format the image was created with
4180 if (image_format != view_format) {
4181 std::stringstream ss;
4182 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02004183 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004184 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004185 skip |=
4186 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4187 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004188 }
4189 }
4190
4191 // Validate correct image aspect bits for desired formats and format consistency
4192 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004193
4194 switch (image_type) {
4195 case VK_IMAGE_TYPE_1D:
4196 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004197 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4198 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004199 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4200 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004201 }
4202 break;
4203 case VK_IMAGE_TYPE_2D:
4204 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4205 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4206 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004207 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4208 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004209 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4210 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004211 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004212 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4213 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004214 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4215 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004216 }
4217 }
4218 break;
4219 case VK_IMAGE_TYPE_3D:
4220 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4221 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4222 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4223 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004224 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004225 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4226 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004227 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4228 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004229 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4230 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004231 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004232 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4233 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004234 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4235 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004236 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4237 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004238 }
4239 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004240 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4241 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004242 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4243 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004244 }
4245 }
4246 } else {
4247 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004248 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4249 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004250 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4251 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004252 }
4253 }
4254 break;
4255 default:
4256 break;
4257 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004258
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004259 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
4260 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
4261 skip |= ValidateCreateImageViewANDROID(device_data, create_info);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004262 }
4263
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004264 VkFormatProperties format_properties = GetPDFormatProperties(device_data, view_format);
4265 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4266 : format_properties.optimalTilingFeatures;
4267
4268 if (tiling_features == 0) {
4269 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4270 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-None-02273",
4271 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4272 "physical device.",
4273 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4274 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4275 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4276 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02274",
4277 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4278 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4279 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4280 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4281 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4282 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02275",
4283 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4284 "VK_IMAGE_USAGE_STORAGE_BIT.",
4285 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4286 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4287 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4288 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4289 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02276",
4290 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4291 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4292 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4293 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4294 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4295 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4296 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-usage-02277",
4297 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4298 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4299 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004300 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004301
Jeff Bolz9af91c52018-09-01 21:53:57 -05004302 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4303 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4304 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4305 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02086",
4306 "vkCreateImageView() If image was created with usage containing "
4307 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4308 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4309 }
4310 if (view_format != VK_FORMAT_R8_UINT) {
4311 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4312 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02087",
4313 "vkCreateImageView() If image was created with usage containing "
4314 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4315 }
4316 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004317 }
4318 return skip;
4319}
4320
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004321void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
4322 auto image_view_map = GetImageViewMap(device_data);
4323 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
4324
4325 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004326 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004327 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4328 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004329}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004330
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004331bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4332 BUFFER_STATE *dst_buffer_state) {
4333 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004334 skip |=
4335 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4336 skip |=
4337 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004338 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004339 skip |=
4340 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4341 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4342 skip |=
4343 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4344 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004345 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004346 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4347 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004348 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004349 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004350 return skip;
4351}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004352
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004353void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
4354 BUFFER_STATE *dst_buffer_state) {
4355 // Update bindings between buffers and cmd buffer
4356 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4357 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004358}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004359
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004360static bool ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004361 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4362 bool skip = false;
4363 auto buffer_state = GetBufferState(device_data, buffer);
4364 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004365 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 -06004366 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01004367 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004368 } else {
4369 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004370 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 -06004371 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004372 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004373 }
4374 }
4375 return skip;
4376}
4377
4378bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
4379 VK_OBJECT *obj_struct) {
4380 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004381 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004382 if (GetDisables(device_data)->destroy_image_view) return false;
4383 bool skip = false;
4384 if (*image_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004385 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView",
4386 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004387 }
4388 return skip;
4389}
4390
John Zulauffca05c12018-04-26 16:30:39 -06004391void PreCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
4392 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004393 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004394 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004395 (*GetImageViewMap(device_data)).erase(image_view);
4396}
4397
4398bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
4399 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02004400 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004401 if (GetDisables(device_data)->destroy_buffer) return false;
4402 bool skip = false;
4403 if (*buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004404 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004405 }
4406 return skip;
4407}
4408
John Zulauffca05c12018-04-26 16:30:39 -06004409void PreCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004410 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004411 for (auto mem_binding : buffer_state->GetBoundMemory()) {
4412 auto mem_info = GetMemObjInfo(device_data, mem_binding);
4413 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004414 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004415 }
4416 }
Petr Krausbc7f5442017-05-14 23:43:38 +02004417 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004418 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004419 GetBufferMap(device_data)->erase(buffer_state->buffer);
4420}
4421
4422bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
4423 VK_OBJECT *obj_struct) {
4424 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02004425 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004426 if (GetDisables(device_data)->destroy_buffer_view) return false;
4427 bool skip = false;
4428 if (*buffer_view_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004429 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView",
4430 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004431 }
4432 return skip;
4433}
4434
John Zulauffca05c12018-04-26 16:30:39 -06004435void PreCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
4436 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004437 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004438 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004439 GetBufferViewMap(device_data)->erase(buffer_view);
4440}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004441
4442bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
4443 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004444 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004445 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004446 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4447 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004448 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4449 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004450 skip |=
4451 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4452 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004453 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004454 return skip;
4455}
4456
4457void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004458 // Update bindings between buffer and cmd buffer
4459 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004460}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004461
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004462bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
4463 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004464 bool skip = false;
4465
4466 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004467 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4468 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004469 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 -06004470 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004471 "%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 -06004472 "and 1, respectively.",
4473 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004474 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004475 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004476
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004477 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4478 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004479 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 -06004480 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004481 "%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 -06004482 "must be 0 and 1, respectively.",
4483 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004484 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004485 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004486
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004487 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4488 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004489 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 -06004490 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004491 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4492 "For 3D images these must be 0 and 1, respectively.",
4493 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004494 }
4495 }
4496
4497 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
4498 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06004499 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06004500 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004501 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 -06004502 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004503 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004504 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
4505 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004506 }
4507
4508 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004509 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004510 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 -06004511 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004512 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4513 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004514 }
4515
4516 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4517 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004518 skip |=
4519 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004520 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004521 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4522 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004523 }
4524
4525 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4526 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4527 skip |= log_msg(
4528 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004529 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004530 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4531 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004532 }
4533
4534 // subresource aspectMask must have exactly 1 bit set
4535 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4536 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4537 if (aspect_mask_bits.count() != 1) {
4538 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 -06004539 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004540 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004541 }
4542
4543 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004544 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004545 skip |= log_msg(
4546 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004547 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004548 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4549 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004550 }
4551
4552 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004553 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004554 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004555
4556 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004557 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004558 skip |= log_msg(
4559 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004560 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004561 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4562 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004563 }
4564
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004565 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004566 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004567 skip |= log_msg(
4568 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004569 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004570 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4571 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004572 }
4573
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004574 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004575 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4576 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4577 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004578 skip |=
4579 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004580 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004581 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4582 "width & height (%d, %d)..",
4583 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004584 }
4585
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004586 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004587 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
4588 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004589 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 -06004590 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004591 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4592 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
4593 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004594 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004595
4596 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004597 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004598 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004599 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4600 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 -06004601 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004602 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004603 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004604 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004605 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004606 }
4607
4608 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004609 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004610 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4611 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 -06004612 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004613 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004614 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004615 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004616 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004617 }
4618
4619 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004620 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004621 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4622 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 -06004623 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004624 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004625 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004626 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004627 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004628 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004629 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004630 }
4631
4632 return skip;
4633}
4634
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004635static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Dave Houltond8ed0212018-05-16 17:18:24 -06004636 const VkBufferImageCopy *pRegions, const char *func_name, std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004637 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004638 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004639
4640 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004641 VkExtent3D extent = pRegions[i].imageExtent;
4642 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004643
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004644 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4645 {
Dave Houlton51653902018-06-22 17:32:13 -06004646 skip |=
4647 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4648 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4649 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004650 }
4651
4652 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4653
4654 // 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 -06004655 if (FormatIsCompressed(image_info->format)) {
4656 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004657 if (image_extent.width % block_extent.width) {
4658 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4659 }
4660 if (image_extent.height % block_extent.height) {
4661 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4662 }
4663 if (image_extent.depth % block_extent.depth) {
4664 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4665 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004666 }
4667
Dave Houltonfc1a4052017-04-27 14:32:45 -06004668 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004669 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 -06004670 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004671 }
4672 }
4673
4674 return skip;
4675}
4676
Chris Forbese8ba09a2017-06-01 17:39:02 -07004677static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004678 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06004679 std::string msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004680 bool skip = false;
4681
4682 VkDeviceSize buffer_size = buff_state->createInfo.size;
4683
4684 for (uint32_t i = 0; i < regionCount; i++) {
4685 VkExtent3D copy_extent = pRegions[i].imageExtent;
4686
4687 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4688 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004689 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004690
Dave Houltonf3229d52017-02-21 15:59:08 -07004691 // Handle special buffer packing rules for specific depth/stencil formats
4692 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06004693 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004694 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4695 switch (image_state->createInfo.format) {
4696 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004697 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004698 break;
4699 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06004700 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004701 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004702 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004703 case VK_FORMAT_D24_UNORM_S8_UINT:
4704 unit_size = 4;
4705 break;
4706 default:
4707 break;
4708 }
4709 }
4710
Tom Cooperb2550c72018-10-15 13:08:41 +01004711 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004712 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06004713 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004714 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4715 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4716
4717 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4718 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4719 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004720 }
4721
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004722 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4723 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4724 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004725 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004726 } else {
4727 // Calculate buffer offset of final copied byte, + 1.
4728 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4729 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4730 max_buffer_offset *= unit_size; // convert to bytes
4731 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004732
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004733 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004734 skip |=
4735 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4736 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004737 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004738 }
4739 }
4740
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004741 return skip;
4742}
4743
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004744bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004745 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004746 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004747 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4748 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4749
4750 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004751 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004752
4753 // Command pool must support graphics, compute, or transfer operations
4754 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4755
4756 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4757 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4758 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 -06004759 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004760 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004761 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004762 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004763 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004764 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004765 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004766 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004767
4768 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004769 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4770 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4771 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4772 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4773 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004774
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004775 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004776 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4777 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4778 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004779 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004780 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4781 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004782 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4783 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004784 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4785 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004786 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004787 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004788 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004789 const std::string src_invalid_layout_vuid =
4790 (src_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4791 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4792 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004793 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004794 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4795 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004796 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004797 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4798 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004799 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004800 "vkCmdCopyImageToBuffer()",
4801 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004802 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4803 "vkCmdCopyImageToBuffer()", "imageSubresource",
4804 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4805 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4806 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4807 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004808 }
4809 return skip;
4810}
4811
4812void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004813 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4814 VkImageLayout src_image_layout) {
4815 // Make sure that all image slices are updated to correct layout
4816 for (uint32_t i = 0; i < region_count; ++i) {
4817 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4818 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004819 // Update bindings between buffer/image and cmd buffer
4820 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004821 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004822}
4823
4824bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004825 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004826 const VkBufferImageCopy *pRegions, const char *func_name) {
4827 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4828 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4829
4830 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004831 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004832
4833 // Command pool must support graphics, compute, or transfer operations
4834 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4835 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4836 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4837 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 -06004838 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004839 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004840 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004841 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004842 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004843 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004844 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004845 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004846 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004847 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4848 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4849 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4850 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4851 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004852 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004853 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4854 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4855 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4856 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4857 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Cort Stratton186b1a22018-05-01 20:18:06 -04004858 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
4859 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004860 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4861 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004862 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004863 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004864 bool hit_error = false;
Cort Stratton7df30962018-05-17 19:45:57 -07004865 const std::string dst_invalid_layout_vuid =
4866 (dst_image_state->shared_presentable && core_validation::GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image)
4867 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4868 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004869 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004870 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4871 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004872 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004873 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4874 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004875 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004876 "vkCmdCopyBufferToImage()",
4877 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004878 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4879 "vkCmdCopyBufferToImage()", "imageSubresource",
4880 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4881 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4882 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4883 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004884 }
4885 return skip;
4886}
4887
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004888void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004889 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4890 VkImageLayout dst_image_layout) {
4891 // Make sure that all image slices are updated to correct layout
4892 for (uint32_t i = 0; i < region_count; ++i) {
4893 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4894 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004895 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004896 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004897}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004898
4899bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4900 const auto report_data = core_validation::GetReportData(device_data);
4901 bool skip = false;
4902 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4903
Dave Houlton1d960ff2018-01-19 12:17:05 -07004904 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004905 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4906 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4907 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004908 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 -06004909 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004910 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004911 }
4912
4913 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4914 if (!image_entry) {
4915 return skip;
4916 }
4917
Dave Houlton1d960ff2018-01-19 12:17:05 -07004918 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004919 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004920 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4921 "VUID-vkGetImageSubresourceLayout-image-00996",
4922 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004923 }
4924
Dave Houlton1d960ff2018-01-19 12:17:05 -07004925 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004926 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004927 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4928 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4929 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4930 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004931 }
4932
Dave Houlton1d960ff2018-01-19 12:17:05 -07004933 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004934 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004935 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4936 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4937 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4938 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004939 }
4940
Dave Houlton1d960ff2018-01-19 12:17:05 -07004941 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004942 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004943 if (FormatIsMultiplane(img_format)) {
4944 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Dave Houltond8ed0212018-05-16 17:18:24 -06004945 std::string vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004946 if (FormatPlaneCount(img_format) > 2u) {
4947 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004948 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004949 }
4950 if (sub_aspect != (sub_aspect & allowed_flags)) {
4951 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 -06004952 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004953 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004954 ") must be a single-plane specifier flag.",
4955 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004956 }
4957 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004958 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004959 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004960 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004961 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004962 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004963 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004964 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004965 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004966 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 -06004967 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004968 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004969 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004970 }
4971 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004972
4973 if (GetDeviceExtensions(device_data)->vk_android_external_memory_android_hardware_buffer) {
4974 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
4975 }
4976
Mike Weiblen672b58b2017-02-21 14:32:53 -07004977 return skip;
4978}