blob: 7be395e84e61a1621d6de49dde4ae00f0d125598 [file] [log] [blame]
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07001/* Copyright (c) 2015-2017 The Khronos Group Inc.
2 * Copyright (c) 2015-2017 Valve Corporation
3 * Copyright (c) 2015-2017 LunarG, Inc.
4 * Copyright (C) 2015-2017 Google Inc.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070020 */
21
22// Allow use of STL min and max functions in Windows
23#define NOMINMAX
24
Mark Lobodzinski90224de2017-01-26 15:23:11 -070025#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020026#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027
28#include "vk_enum_string_helper.h"
29#include "vk_layer_data.h"
30#include "vk_layer_utils.h"
31#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060032#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070034#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070035
Tobin Ehlis58c884f2017-02-08 12:15:27 -070036void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070037 auto it = pCB->imageLayoutMap.find(imgpair);
38 if (it != pCB->imageLayoutMap.end()) {
39 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070040 } else {
41 assert(imgpair.hasSubresource);
42 IMAGE_CMD_BUF_LAYOUT_NODE node;
43 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
44 node.initialLayout = layout;
45 }
46 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
47 }
48}
49template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070050void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070051 ImageSubresourcePair imgpair = {image, true, range};
52 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
53 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
54 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
55 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -070056 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
57 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
58 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
59 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
60 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070061}
62
63template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070064void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070065 VkImageAspectFlags aspectMask) {
66 if (imgpair.subresource.aspectMask & aspectMask) {
67 imgpair.subresource.aspectMask = aspectMask;
68 SetLayout(device_data, pObject, imgpair, layout);
69 }
70}
71
Tony Barbourdf013b92017-01-25 12:53:48 -070072// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070073void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
74 VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070075 auto it = imageLayoutMap.find(imgpair);
76 if (it != imageLayoutMap.end()) {
77 it->second.layout = layout; // Update
78 } else {
79 imageLayoutMap[imgpair].layout = layout; // Insert
80 }
Tony Barbourdf013b92017-01-25 12:53:48 -070081}
82
Tobin Ehlisc8266452017-04-07 12:20:30 -060083bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070084 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
85 const debug_report_data *report_data = core_validation::GetReportData(device_data);
86
87 if (!(imgpair.subresource.aspectMask & aspectMask)) {
88 return false;
89 }
90 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
91 imgpair.subresource.aspectMask = aspectMask;
92 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
93 if (imgsubIt == pCB->imageLayoutMap.end()) {
94 return false;
95 }
96 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +020097 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
Mark Lobodzinski88529492018-04-01 10:38:15 -060098 DRAWSTATE_INVALID_LAYOUT,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070099 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200100 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700101 string_VkImageLayout(imgsubIt->second.layout));
102 }
103 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200104 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
Mark Lobodzinski88529492018-04-01 10:38:15 -0600105 DRAWSTATE_INVALID_LAYOUT,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700106 "Cannot query for VkImage 0x%" PRIx64
107 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200108 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700109 string_VkImageLayout(imgsubIt->second.initialLayout));
110 }
111 node = imgsubIt->second;
112 return true;
113}
114
Tobin Ehlisc8266452017-04-07 12:20:30 -0600115bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700116 const VkImageAspectFlags aspectMask) {
117 if (!(imgpair.subresource.aspectMask & aspectMask)) {
118 return false;
119 }
120 const debug_report_data *report_data = core_validation::GetReportData(device_data);
121 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
122 imgpair.subresource.aspectMask = aspectMask;
123 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
124 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
125 return false;
126 }
127 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200128 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
Mark Lobodzinski88529492018-04-01 10:38:15 -0600129 DRAWSTATE_INVALID_LAYOUT,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700130 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200131 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700132 string_VkImageLayout(imgsubIt->second.layout));
133 }
134 layout = imgsubIt->second.layout;
135 return true;
136}
137
138// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600139bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700140 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
141 ImageSubresourcePair imgpair = {image, true, range};
142 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
143 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
144 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
145 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
146 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700147 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
148 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
149 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
150 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
151 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700152 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
153 imgpair = {image, false, VkImageSubresource()};
154 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
155 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
156 // TODO: This is ostensibly a find function but it changes state here
157 node = imgsubIt->second;
158 }
159 return true;
160}
161
162// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700163bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700164 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
165 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
166 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
167 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
168 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700169 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
170 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
171 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
172 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
173 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700174 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
175 imgpair = {imgpair.image, false, VkImageSubresource()};
176 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
177 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
178 layout = imgsubIt->second.layout;
179 }
180 return true;
181}
182
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700183bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700184 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
185 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700186 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700187 if (!image_state) return false;
188 bool ignoreGlobal = false;
189 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
190 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
191 ignoreGlobal = true;
192 }
193 for (auto imgsubpair : sub_data->second) {
194 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
195 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
196 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
197 layouts.push_back(img_data->second.layout);
198 }
199 }
200 return true;
201}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700202bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
203 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700204 if (!(imgpair.subresource.aspectMask & aspectMask)) {
205 return false;
206 }
207 imgpair.subresource.aspectMask = aspectMask;
208 auto imgsubIt = imageLayoutMap.find(imgpair);
209 if (imgsubIt == imageLayoutMap.end()) {
210 return false;
211 }
212 layout = imgsubIt->second.layout;
213 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700214}
Tony Barbourdf013b92017-01-25 12:53:48 -0700215
216// find layout in supplied map
Dave Houltonb3f4b282018-02-22 16:25:16 -0700217bool FindLayout(layer_data *device_data, const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
218 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700219 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
220 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
221 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
222 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
223 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700224 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
225 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
226 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
227 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
228 }
229 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700230 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
231 imgpair = {imgpair.image, false, VkImageSubresource()};
232 auto imgsubIt = imageLayoutMap.find(imgpair);
233 if (imgsubIt == imageLayoutMap.end()) return false;
234 layout = imgsubIt->second.layout;
235 }
236 return true;
237}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700238
239// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700240void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700241 VkImage &image = imgpair.image;
Dave Houltonb3f4b282018-02-22 16:25:16 -0700242 auto &lmap = (*core_validation::GetImageLayoutMap(device_data));
243 auto data = lmap.find(imgpair);
244 if (data != lmap.end()) {
245 data->second.layout = layout; // Update
246 } else {
247 lmap[imgpair].layout = layout; // Insert
248 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700249 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
250 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
251 if (subresource == image_subresources.end()) {
252 image_subresources.push_back(imgpair);
253 }
254}
255
256// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700257void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700258 auto it = pCB->imageLayoutMap.find(imgpair);
259 if (it != pCB->imageLayoutMap.end()) {
260 it->second = node; // Update
261 } else {
262 pCB->imageLayoutMap[imgpair] = node; // Insert
263 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700264}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600265// Set image layout for given VkImageSubresourceRange struct
266void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
267 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
268 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700269 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600270 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
271 uint32_t level = image_subresource_range.baseMipLevel + level_index;
272 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
273 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
274 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700275 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
276 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600277 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600278 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700279 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
280 }
281 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600282 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700283 }
284 }
285}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600286// Set image layout for given VkImageSubresourceLayers struct
287void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
288 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
289 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
290 VkImageSubresourceRange image_subresource_range;
291 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
292 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
293 image_subresource_range.layerCount = image_subresource_layers.layerCount;
294 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
295 image_subresource_range.levelCount = 1;
296 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
297}
298// Set image layout for all slices of an image view
299void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
300 auto view_state = GetImageViewState(device_data, imageView);
301 assert(view_state);
302
303 SetImageLayout(device_data, cb_node, GetImageState(device_data, view_state->create_info.image),
304 view_state->create_info.subresourceRange, layout);
305}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700306
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700307bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700308 const VkRenderPassBeginInfo *pRenderPassBegin,
309 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600310 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700311 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700312 auto const &framebufferInfo = framebuffer_state->createInfo;
313 const auto report_data = core_validation::GetReportData(device_data);
314 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600315 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600316 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700317 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700318 }
319 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
320 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700321 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700322 assert(view_state);
323 const VkImage &image = view_state->create_info.image;
324 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700325 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700326 // TODO: Do not iterate over every possibility - consolidate where possible
327 for (uint32_t j = 0; j < subRange.levelCount; j++) {
328 uint32_t level = subRange.baseMipLevel + j;
329 for (uint32_t k = 0; k < subRange.layerCount; k++) {
330 uint32_t layer = subRange.baseArrayLayer + k;
331 VkImageSubresource sub = {subRange.aspectMask, level, layer};
332 IMAGE_CMD_BUF_LAYOUT_NODE node;
333 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700334 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700335 continue;
336 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700337 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600338 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600339 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700340 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
341 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
342 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600343 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700344 }
345 }
346 }
347 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600348 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700349}
350
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700351void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700352 VkAttachmentReference ref) {
353 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
354 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
355 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
356 }
357}
358
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700359void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700360 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700361 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700362
363 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700364 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700365 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
366 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
367 }
368 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
369 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
370 }
371 if (subpass.pDepthStencilAttachment) {
372 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
373 }
374 }
375}
376
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600377bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700378 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700379 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
380 return false;
381 }
382 VkImageSubresource sub = {aspect, level, layer};
383 IMAGE_CMD_BUF_LAYOUT_NODE node;
384 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700385 return false;
386 }
387 bool skip = false;
388 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
389 // TODO: Set memory invalid which is in mem_tracker currently
390 } else if (node.layout != mem_barrier->oldLayout) {
Cort Strattond46dcb52018-04-10 14:52:49 -0700391 skip =
392 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
393 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer), VALIDATION_ERROR_0a00095a,
394 "For image 0x%" PRIx64
395 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
396 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
397 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700398 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700399 return skip;
400}
401
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700402// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
403// 1. Transition into initialLayout state
404// 2. Transition from initialLayout to layout used in subpass 0
405void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
406 FRAMEBUFFER_STATE *framebuffer_state) {
407 // First transition into initialLayout
408 auto const rpci = render_pass_state->createInfo.ptr();
409 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
410 VkImageView image_view = framebuffer_state->createInfo.pAttachments[i];
411 SetImageViewLayout(device_data, cb_state, image_view, rpci->pAttachments[i].initialLayout);
412 }
413 // Now transition for first subpass (index 0)
414 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
415}
416
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700417void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
418 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
419 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
420 return;
421 }
422 VkImageSubresource sub = {aspect, level, layer};
423 IMAGE_CMD_BUF_LAYOUT_NODE node;
424 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700425 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700426 SetLayout(device_data, pCB, mem_barrier->image, sub,
427 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
428 return;
429 }
430 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
431 // TODO: Set memory invalid
432 }
433 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
434}
435
Dave Houlton10b39482017-03-16 13:18:15 -0600436bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600437 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600438 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600439 }
440 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600441 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600442 }
443 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600444 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600445 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700446 if (0 !=
447 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
448 if (FormatPlaneCount(format) == 1) return false;
449 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600450 return true;
451}
452
Mike Weiblen62d08a32017-03-07 22:18:27 -0700453// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
454bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
455 VkImageUsageFlags usage_flags, const char *func_name) {
456 const auto report_data = core_validation::GetReportData(device_data);
457 bool skip = false;
458 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
459 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
460
461 switch (layout) {
462 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
463 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600464 msg_code = VALIDATION_ERROR_0a000970;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700465 }
466 break;
467 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
468 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600469 msg_code = VALIDATION_ERROR_0a000972;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700470 }
471 break;
472 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
473 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600474 msg_code = VALIDATION_ERROR_0a000974;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700475 }
476 break;
477 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
478 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600479 msg_code = VALIDATION_ERROR_0a000976;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700480 }
481 break;
482 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
483 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600484 msg_code = VALIDATION_ERROR_0a000978;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700485 }
486 break;
487 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
488 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600489 msg_code = VALIDATION_ERROR_0a00097a;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700490 }
491 break;
492 default:
493 // Other VkImageLayout values do not have VUs defined in this context.
494 break;
495 }
496
497 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600498 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 -0600499 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600500 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
501 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
502 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700503 }
504 return skip;
505}
506
507// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600508bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700509 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700510 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700511
Mike Weiblen62d08a32017-03-07 22:18:27 -0700512 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
513 auto img_barrier = &pImageMemoryBarriers[i];
514 if (!img_barrier) continue;
515
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600516 auto image_state = GetImageState(device_data, img_barrier->image);
517 if (image_state) {
518 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
519 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
520 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
521
522 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
523 if (image_state->layout_locked) {
524 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600525 skip |= log_msg(
526 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600527 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100528 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600529 " 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 +0100530 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600531 string_VkImageLayout(img_barrier->newLayout));
532 }
533 }
534
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600535 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600536 // For a Depth/Stencil image both aspects MUST be set
537 if (FormatIsDepthAndStencil(image_create_info->format)) {
538 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
539 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
540 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600541 skip |=
542 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
543 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), VALIDATION_ERROR_0a00096e,
544 "%s: Image barrier 0x%p references image 0x%" PRIx64
545 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
546 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
547 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600548 }
549 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600550 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
551 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700552
Mike Weiblen62d08a32017-03-07 22:18:27 -0700553 for (uint32_t j = 0; j < level_count; j++) {
554 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
555 for (uint32_t k = 0; k < layer_count; k++) {
556 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600557 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
558 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
559 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
560 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700561 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
562 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
563 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
564 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
565 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
566 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
567 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
568 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700569 }
570 }
571 }
572 return skip;
573}
574
Chris Forbes4de4b132017-08-21 11:27:08 -0700575static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600576 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700577
578 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600579 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700580}
581
Chris Forbes399a6782017-08-18 15:00:48 -0700582void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700583 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700584 for (uint32_t i = 0; i < memBarrierCount; ++i) {
585 auto mem_barrier = &pImgMemBarriers[i];
586 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700587
Chris Forbes4de4b132017-08-21 11:27:08 -0700588 // For ownership transfers, the barrier is specified twice; as a release
589 // operation on the yielding queue family, and as an acquire operation
590 // on the acquiring queue family. This barrier may also include a layout
591 // transition, which occurs 'between' the two operations. For validation
592 // purposes it doesn't seem important which side performs the layout
593 // transition, but it must not be performed twice. We'll arbitrarily
594 // choose to perform it as part of the acquire operation.
595 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
596 continue;
597 }
598
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600599 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
600 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
601 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
602
Dave Houltonb3f4b282018-02-22 16:25:16 -0700603 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
604 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
605 // for all (potential) layer sub_resources.
606 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
607 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
608 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
609 }
610
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600611 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700612 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600613 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700614 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Chris Forbes399a6782017-08-18 15:00:48 -0700615 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
616 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
617 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
618 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700619 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Chris Forbes399a6782017-08-18 15:00:48 -0700620 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
621 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
622 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700623 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700624 }
625 }
626 }
627}
628
Tobin Ehlisc8266452017-04-07 12:20:30 -0600629bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600630 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600631 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700632 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600633 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600634 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700635
636 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
637 uint32_t layer = i + subLayers.baseArrayLayer;
638 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
639 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600640 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
641 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600642 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600643 // TODO: Improve log message in the next pass
Petr Kraus13c98a62017-12-09 00:22:39 +0100644 skip |= log_msg(
645 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600646 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Petr Kraus13c98a62017-12-09 00:22:39 +0100647 "%s: Cannot use image 0x%" PRIx64 " with specific layout %s that doesn't match the actual current layout %s.",
648 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600649 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700650 }
651 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600652 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
653 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
654 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700655 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
656 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600657 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600658 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -0600659 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Petr Kraus13c98a62017-12-09 00:22:39 +0100660 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
661 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700662 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600663 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600664 if (image_state->shared_presentable) {
665 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
666 // TODO: Add unique error id when available.
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600667 skip |=
668 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, msg_code,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600669 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600670 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600671 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600672 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700673 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600674 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600675 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600676 HandleToUint64(cb_node->commandBuffer), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600677 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
678 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700679 }
680 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600681 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700682}
683
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700684void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
685 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700686 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700687 if (!renderPass) return;
688
689 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
690 if (framebuffer_state) {
691 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
692 auto image_view = framebuffer_state->createInfo.pAttachments[i];
693 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
694 }
695 }
696}
Dave Houltone19e20d2018-02-02 16:32:41 -0700697
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700698bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700699 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600700 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700701 const debug_report_data *report_data = core_validation::GetReportData(device_data);
702
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600703 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600704 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600705 VALIDATION_ERROR_09e0075e, "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600706
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600707 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600708 }
709
Dave Houlton130c0212018-01-29 13:39:56 -0700710 const char *format_string = string_VkFormat(pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700711
712 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
713 std::stringstream ss;
714 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 -0600715 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600716 VALIDATION_ERROR_09e0076a, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700717 }
718
719 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
720 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
721 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
722 if (VK_SUCCESS != err) {
723 std::stringstream ss;
724 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
725 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600726 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600727 VALIDATION_ERROR_09e00758, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700728 return skip;
729 }
730
731 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
732 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
733 std::stringstream ss;
734 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600735 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600736 VALIDATION_ERROR_09e0076e, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700737 }
738
739 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
740 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
741 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
742 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600743 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700744 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600745 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600746 VALIDATION_ERROR_09e00770, "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600747 }
Dave Houlton130c0212018-01-29 13:39:56 -0700748 } else {
749 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
750 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600751 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700752 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
753 "format "
754 << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600755 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600756 VALIDATION_ERROR_09e00772, "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600757 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600758 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700759 }
760
Dave Houlton130c0212018-01-29 13:39:56 -0700761 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
762 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
763 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
764 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
765 std::stringstream ss;
766 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600767 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600768 VALIDATION_ERROR_09e00776, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700769 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700770 }
771
Dave Houlton130c0212018-01-29 13:39:56 -0700772 // NOTE: As of 1/30/2018 the spec VU language is as in the commented code below. I believe this is an
Dave Houltone19e20d2018-02-02 16:32:41 -0700773 // error in the spec, and have submitted Gitlab Vulkan issue #1151 to have it changed to match the
Dave Houlton130c0212018-01-29 13:39:56 -0700774 // implementation shown. DJH
775 //
776 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
777 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
778 // device_limits->maxImageDimension3D)) {
779 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
780 std::stringstream ss;
781 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600782 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600783 VALIDATION_ERROR_09e0077e, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700784 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700785
Dave Houlton130c0212018-01-29 13:39:56 -0700786 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
787 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
788 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
789 std::stringstream ss;
790 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
791 "maxFramebufferWidth";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600792 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600793 VALIDATION_ERROR_09e00788, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700794 }
795
796 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
797 std::stringstream ss;
798 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
799 "maxFramebufferHeight";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600801 VALIDATION_ERROR_09e0078a, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700802 }
803
804 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
805 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
806 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
807
808 // Round up to imageGranularity boundary
809 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
810 uint64_t ig_mask = imageGranularity - 1;
811 total_size = (total_size + ig_mask) & ~ig_mask;
812
813 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600814 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600815 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700816 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
817 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -0700818 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700819 }
820
Dave Houlton130c0212018-01-29 13:39:56 -0700821 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600822 skip |=
823 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, VALIDATION_ERROR_09e00780,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600824 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d.", pCreateInfo->arrayLayers,
825 format_limits.maxArrayLayers);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700826 }
827
Dave Houlton130c0212018-01-29 13:39:56 -0700828 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600829 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600830 VALIDATION_ERROR_09e0078e, "CreateImage samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600831 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700832 }
833
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600834 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600835 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600836 DRAWSTATE_INVALID_FEATURE,
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600837 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
838 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600839 }
840
Lenny Komowb79f04a2017-09-18 17:07:00 -0600841 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
842 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
843 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
844 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
845 // TODO: Add Maintenance2 VUID
846 skip |=
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600847 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600848 VALIDATION_ERROR_UNDEFINED,
Lenny Komowb79f04a2017-09-18 17:07:00 -0600849 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
850 "format must be block, ETC or ASTC compressed, but is %s",
851 string_VkFormat(pCreateInfo->format));
852 }
853 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
854 // TODO: Add Maintenance2 VUID
855 skip |=
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600856 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600857 VALIDATION_ERROR_UNDEFINED,
Lenny Komowb79f04a2017-09-18 17:07:00 -0600858 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
859 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
860 }
861 }
862 }
863
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600864 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700865}
866
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700867void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700868 IMAGE_LAYOUT_NODE image_state;
869 image_state.layout = pCreateInfo->initialLayout;
870 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700871 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(new IMAGE_STATE(*pImage, pCreateInfo))));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700872 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700873 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
874 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700875}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700876
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700877bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700878 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700879 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200880 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700881 if (disabled->destroy_image) return false;
882 bool skip = false;
883 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600884 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
885 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700886 }
887 return skip;
888}
889
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700890void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700891 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
892 // Clean up memory mapping, bindings and range references for image
893 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700894 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700895 if (mem_info) {
896 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
897 }
898 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600899 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700900 // Remove image from imageMap
901 core_validation::GetImageMap(device_data)->erase(image);
902 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
903 core_validation::GetImageSubresourceMap(device_data);
904
905 const auto &sub_entry = imageSubresourceMap->find(image);
906 if (sub_entry != imageSubresourceMap->end()) {
907 for (const auto &pair : sub_entry->second) {
908 core_validation::GetImageLayoutMap(device_data)->erase(pair);
909 }
910 imageSubresourceMap->erase(sub_entry);
911 }
912}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700913
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700914bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700915 bool skip = false;
916 const debug_report_data *report_data = core_validation::GetReportData(device_data);
917
918 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
919 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
920 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 -0600921 HandleToUint64(image_state->image), DRAWSTATE_INVALID_IMAGE_ASPECT, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700922 }
923
Dave Houlton1d2022c2017-03-29 11:43:58 -0600924 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700925 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
926 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 -0600927 HandleToUint64(image_state->image), VALIDATION_ERROR_1880000e, "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600928 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700929 char const str[] = "vkCmdClearColorImage called with compressed image.";
930 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 -0600931 HandleToUint64(image_state->image), VALIDATION_ERROR_1880000e, "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700932 }
933
934 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
935 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
936 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 -0600937 HandleToUint64(image_state->image), VALIDATION_ERROR_18800004, "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700938 }
939 return skip;
940}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700941
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600942uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
943 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
944 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700945 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600946 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700947 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600948 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700949}
950
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600951uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
952 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
953 uint32_t array_layer_count = range->layerCount;
954 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
955 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700956 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600957 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700958}
959
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700960bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700961 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
962 bool skip = false;
963 const debug_report_data *report_data = core_validation::GetReportData(device_data);
964
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600965 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
966 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700967
968 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
969 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700970 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
971 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600972 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600973 HandleToUint64(image_state->image), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700974 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
975 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600976 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600977 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600978 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600979 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 -0600980 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -0600981 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
982 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600983
984 } else {
985 if (image_state->shared_presentable) {
986 skip |= log_msg(
987 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600988 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600989 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
990 string_VkImageLayout(dest_image_layout));
991 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600992 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700993 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600994 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700995 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600996 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700997 } else {
998 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
999 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001000 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 -06001001 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001002 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1003 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001004 }
1005 }
1006
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001007 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1008 uint32_t level = level_index + range.baseMipLevel;
1009 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1010 uint32_t layer = layer_index + range.baseArrayLayer;
1011 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001012 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001013 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001014 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001015 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001016 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001017 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001018 } else {
1019 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1020 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001021 skip |=
1022 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1023 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1024 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001025 }
1026 }
1027 }
1028 }
1029
1030 return skip;
1031}
1032
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001033void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1034 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001035 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1036 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1037 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001038
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001039 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1040 uint32_t level = level_index + range.baseMipLevel;
1041 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1042 uint32_t layer = layer_index + range.baseArrayLayer;
1043 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001044 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001045 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1046 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 -07001047 }
1048 }
1049 }
1050}
1051
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001052bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001053 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1054 bool skip = false;
1055 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001056 auto cb_node = GetCBNode(dev_data, commandBuffer);
1057 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001058 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001059 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001060 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001061 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001062 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001063 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001064 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001065 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001066 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001067 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001068 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001069 }
1070 }
1071 return skip;
1072}
1073
1074// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001075void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001076 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001077 auto cb_node = GetCBNode(dev_data, commandBuffer);
1078 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001079 if (cb_node && image_state) {
1080 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1081 std::function<bool()> function = [=]() {
1082 SetImageMemoryValid(dev_data, image_state, true);
1083 return false;
1084 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001085 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001086 for (uint32_t i = 0; i < rangeCount; ++i) {
1087 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1088 }
1089 }
1090}
1091
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001092bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1093 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001094 const VkImageSubresourceRange *pRanges) {
1095 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001096 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1097
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001098 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001099 auto cb_node = GetCBNode(device_data, commandBuffer);
1100 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001101 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001102 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001103 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001104 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001105 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001106 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001107 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001108 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001109 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001110 skip |=
1111 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001112 // Image aspect must be depth or stencil or both
1113 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1114 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1115 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001116 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1117 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001118 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001119 HandleToUint64(commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001120 }
1121 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001122 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001123 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001124 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 -06001125 HandleToUint64(image), VALIDATION_ERROR_18a0001c, "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001126 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001127 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1128 char const str[] =
1129 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1130 "set.";
1131 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 -06001132 HandleToUint64(image), VALIDATION_ERROR_18a00012, "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001133 }
1134 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1135 VkImageTiling tiling = image_state->createInfo.tiling;
1136 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1137 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1138 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001139 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 -06001140 HandleToUint64(image), VALIDATION_ERROR_18a00010,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001141 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1142 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR.",
1143 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling));
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001144 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001145 }
1146 return skip;
1147}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001148
1149// Returns true if [x, xoffset] and [y, yoffset] overlap
1150static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1151 bool result = false;
1152 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1153 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1154
1155 if (intersection_max > intersection_min) {
1156 result = true;
1157 }
1158 return result;
1159}
1160
Dave Houltonc991cc92018-03-06 11:08:51 -07001161// Returns true if source area of first copy region intersects dest area of second region
1162// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1163static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001164 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001165
Dave Houltonc991cc92018-03-06 11:08:51 -07001166 // Separate planes within a multiplane image cannot intersect
1167 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001168 return result;
1169 }
1170
Dave Houltonc991cc92018-03-06 11:08:51 -07001171 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1172 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1173 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001174 result = true;
1175 switch (type) {
1176 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001177 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001178 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001179 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001180 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001181 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001182 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001183 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001184 break;
1185 default:
1186 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1187 assert(false);
1188 }
1189 }
1190 return result;
1191}
1192
Dave Houltonfc1a4052017-04-27 14:32:45 -06001193// Returns non-zero if offset and extent exceed image extents
1194static const uint32_t x_bit = 1;
1195static const uint32_t y_bit = 2;
1196static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001197static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001198 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001199 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001200 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1201 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001202 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001203 }
1204 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1205 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001206 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001207 }
1208 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1209 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001210 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001211 }
1212 return result;
1213}
1214
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001215// Test if two VkExtent3D structs are equivalent
1216static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1217 bool result = true;
1218 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1219 (extent->depth != other_extent->depth)) {
1220 result = false;
1221 }
1222 return result;
1223}
1224
Dave Houltonee281a52017-12-08 13:51:02 -07001225// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1226// Destination image texel extents must be adjusted by block size for the dest validation checks
1227VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1228 VkExtent3D adjusted_extent = extent;
1229 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1230 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1231 adjusted_extent.width /= block_size.width;
1232 adjusted_extent.height /= block_size.height;
1233 adjusted_extent.depth /= block_size.depth;
1234 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1235 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1236 adjusted_extent.width *= block_size.width;
1237 adjusted_extent.height *= block_size.height;
1238 adjusted_extent.depth *= block_size.depth;
1239 }
1240 return adjusted_extent;
1241}
1242
Dave Houlton6f9059e2017-05-02 17:15:13 -06001243// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001244static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1245 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001246
1247 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001248 if (mip >= img->createInfo.mipLevels) {
1249 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001250 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001251
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001252 // 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 -06001253 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001254 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1255 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1256 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001257
Dave Houlton6f9059e2017-05-02 17:15:13 -06001258 // Image arrays have an effective z extent that isn't diminished by mip level
1259 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001260 extent.depth = img->createInfo.arrayLayers;
1261 }
1262
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001263 return extent;
1264}
1265
1266// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001267static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001268 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1269}
1270
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001271// Test if the extent argument has any dimensions set to 0.
1272static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1273 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1274}
1275
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001276// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1277static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1278 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1279 VkExtent3D granularity = {0, 0, 0};
1280 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1281 if (pPool) {
1282 granularity =
1283 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001284 if (FormatIsCompressed(img->createInfo.format)) {
1285 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001286 granularity.width *= block_size.width;
1287 granularity.height *= block_size.height;
1288 }
1289 }
1290 return granularity;
1291}
1292
1293// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1294static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1295 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001296 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1297 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001298 valid = false;
1299 }
1300 return valid;
1301}
1302
1303// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1304static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1305 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1306 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1307 bool skip = false;
1308 VkExtent3D offset_extent = {};
1309 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1310 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1311 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001312 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001313 // 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 -07001314 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001315 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001316 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001317 "%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 "
1318 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001319 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001320 }
1321 } else {
1322 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1323 // integer multiples of the image transfer granularity.
1324 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001325 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001326 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001327 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1328 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001329 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1330 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001331 }
1332 }
1333 return skip;
1334}
1335
1336// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1337static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1338 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001339 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001340 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1341 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001342 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001343 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1344 // subresource extent.
1345 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001346 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001347 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Petr Krausbc7f5442017-05-14 23:43:38 +02001348 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1349 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1350 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1351 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001352 }
1353 } else {
1354 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1355 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1356 // subresource extent dimensions.
1357 VkExtent3D offset_extent_sum = {};
1358 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1359 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1360 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001361 bool x_ok = true;
1362 bool y_ok = true;
1363 bool z_ok = true;
1364 switch (image_type) {
1365 case VK_IMAGE_TYPE_3D:
1366 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1367 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001368 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001369 case VK_IMAGE_TYPE_2D:
1370 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1371 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001372 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001373 case VK_IMAGE_TYPE_1D:
1374 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1375 (subresource_extent->width == offset_extent_sum.width));
1376 break;
1377 default:
1378 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1379 assert(false);
1380 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001381 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001382 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001383 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001384 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1385 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1386 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1387 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1388 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1389 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001390 }
1391 }
1392 return skip;
1393}
1394
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001395// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001396bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1397 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1398 const uint32_t i, const char *function) {
1399 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001400 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001401 // TODO: Add granularity checking for compressed formats
1402
1403 // bufferRowLength must be a multiple of the compressed texel block width
1404 // bufferImageHeight must be a multiple of the compressed texel block height
1405 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1406 // bufferOffset must be a multiple of the compressed texel block size in bytes
1407 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1408 // must equal the image subresource width
1409 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1410 // must equal the image subresource height
1411 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1412 // must equal the image subresource depth
1413 } else {
1414 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001415 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1416 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1417 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001418 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001419 }
1420 return skip;
1421}
1422
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001423// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001424bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001425 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1426 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001427 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001428 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001429 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001430 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001431 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001432 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001433 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001434 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001435
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001436 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001437 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001438 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houltonee281a52017-12-08 13:51:02 -07001439 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001440 const VkExtent3D dest_effective_extent =
1441 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001442 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001443 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001444 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001445 return skip;
1446}
1447
Dave Houlton6f9059e2017-05-02 17:15:13 -06001448// Validate contents of a VkImageCopy struct
1449bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1450 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1451 bool skip = false;
1452
1453 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001454 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001455
1456 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001457 const VkExtent3D src_copy_extent = region.extent;
1458 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001459 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1460
Dave Houlton6f9059e2017-05-02 17:15:13 -06001461 bool slice_override = false;
1462 uint32_t depth_slices = 0;
1463
1464 // Special case for copying between a 1D/2D array and a 3D image
1465 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1466 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001467 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001468 slice_override = (depth_slices != 1);
1469 } 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 -07001470 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001471 slice_override = (depth_slices != 1);
1472 }
1473
1474 // Do all checks on source image
1475 //
1476 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001477 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1478 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 -06001479 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00124,
Dave Houltonee281a52017-12-08 13:51:02 -07001480 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001481 "be 0 and 1, respectively.",
1482 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001483 }
1484 }
1485
Dave Houlton533be9f2018-03-26 17:08:30 -06001486 // VUID-VkImageCopy-srcImage-01785
1487 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1488 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 -06001489 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00df2,
Dave Houlton533be9f2018-03-26 17:08:30 -06001490 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001491 "these must be 0 and 1, respectively.",
1492 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001493 }
1494
Dave Houlton533be9f2018-03-26 17:08:30 -06001495 // VUID-VkImageCopy-srcImage-01787
1496 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1497 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 -06001498 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00df6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001499 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
1500 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06001501 }
1502
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001503 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001504 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001505 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001506 skip |=
1507 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001508 HandleToUint64(src_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001509 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001510 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1511 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001512 }
1513 }
1514 } else { // Pre maint 1
1515 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001516 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001517 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 -06001518 HandleToUint64(src_state->image), VALIDATION_ERROR_09c0011a,
Petr Kraus13c98a62017-12-09 00:22:39 +01001519 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1520 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001521 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1522 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001523 }
1524 }
1525 }
1526
Dave Houltonc991cc92018-03-06 11:08:51 -07001527 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1528 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
1529 if (FormatIsCompressed(src_state->createInfo.format) ||
1530 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001531 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001532 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001533 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1534 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1535 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001536 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d7e : VALIDATION_ERROR_09c0013a;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001537 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 -07001538 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001539 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001540 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001541 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001542 }
1543
Dave Houlton94a00372017-12-14 15:08:47 -07001544 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001545 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1546 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001547 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d80 : VALIDATION_ERROR_09c0013c;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001548 skip |=
1549 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001550 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001551 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001552 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001553 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001554 }
1555
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001556 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001557 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1558 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001559 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d82 : VALIDATION_ERROR_09c0013e;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001560 skip |=
1561 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001562 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001563 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001564 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001565 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001566 }
1567
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001568 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001569 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1570 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001571 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d84 : VALIDATION_ERROR_09c00140;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001572 skip |=
1573 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001574 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001575 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001576 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001577 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001578 }
1579 } // Compressed
1580
1581 // Do all checks on dest image
1582 //
1583 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001584 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001585 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 -06001586 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00130,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001587 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001588 "these must be 0 and 1, respectively.",
1589 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001590 }
1591 }
1592
Dave Houlton533be9f2018-03-26 17:08:30 -06001593 // VUID-VkImageCopy-dstImage-01786
1594 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
1595 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 -06001596 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00df4,
Dave Houlton533be9f2018-03-26 17:08:30 -06001597 "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 -06001598 "and 1, respectively.",
1599 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06001600 }
1601
1602 // VUID-VkImageCopy-dstImage-01788
1603 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
1604 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 -06001605 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00df8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001606 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
1607 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001608 }
1609
1610 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001611 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001612 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 -06001613 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001614 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001615 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1616 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001617 }
1618 }
1619 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001620 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001621 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001622 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001623 skip |=
1624 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001625 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001626 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001627 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1628 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001629 }
1630 }
1631 } else { // Pre maint 1
1632 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001633 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001634 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 -06001635 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Petr Kraus13c98a62017-12-09 00:22:39 +01001636 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1637 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001638 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1639 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001640 }
1641 }
1642 }
1643
Dave Houltonc991cc92018-03-06 11:08:51 -07001644 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1645 if (FormatIsCompressed(dst_state->createInfo.format) ||
1646 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001647 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001648
1649 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001650 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1651 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1652 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001653 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d86 : VALIDATION_ERROR_09c00144;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001654 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 -07001655 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001656 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001657 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001658 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001659 }
1660
Dave Houlton94a00372017-12-14 15:08:47 -07001661 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001662 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1663 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001664 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d88 : VALIDATION_ERROR_09c00146;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001665 skip |=
1666 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001667 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001668 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001669 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001670 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001671 }
1672
Dave Houltonee281a52017-12-08 13:51:02 -07001673 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1674 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1675 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001676 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d8a : VALIDATION_ERROR_09c00148;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001677 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 -07001678 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001679 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1680 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07001681 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001682 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001683 }
1684
Dave Houltonee281a52017-12-08 13:51:02 -07001685 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1686 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1687 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001688 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d8c : VALIDATION_ERROR_09c0014a;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001689 skip |=
1690 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001691 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001692 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001693 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001694 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001695 }
1696 } // Compressed
1697 }
1698 return skip;
1699}
1700
Dave Houltonc991cc92018-03-06 11:08:51 -07001701// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
1702bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
1703 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
1704 bool skip = false;
1705 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
1706
1707 // Neither image is multiplane
1708 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
1709 // If neither image is multi-plane the aspectMask member of src and dst must match
1710 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1711 std::stringstream ss;
1712 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
1713 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
1714 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1715 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c1e, "%s.", ss.str().c_str());
1716 }
1717 } else {
1718 // Source image multiplane checks
1719 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
1720 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
1721 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
1722 std::stringstream ss;
1723 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
1724 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1725 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c20, "%s.", ss.str().c_str());
1726 }
1727 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
1728 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
1729 std::stringstream ss;
1730 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
1731 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1732 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c22, "%s.", ss.str().c_str());
1733 }
1734 // Single-plane to multi-plane
1735 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
1736 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
1737 std::stringstream ss;
1738 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
1739 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1740 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c2a, "%s.", ss.str().c_str());
1741 }
1742
1743 // Dest image multiplane checks
1744 planes = FormatPlaneCount(dst_image_state->createInfo.format);
1745 aspect = region.dstSubresource.aspectMask;
1746 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
1747 std::stringstream ss;
1748 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
1749 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1750 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c24, "%s.", ss.str().c_str());
1751 }
1752 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
1753 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
1754 std::stringstream ss;
1755 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
1756 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1757 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c26, "%s.", ss.str().c_str());
1758 }
1759 // Multi-plane to single-plane
1760 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
1761 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
1762 std::stringstream ss;
1763 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
1764 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1765 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c28, "%s.", ss.str().c_str());
1766 }
1767 }
1768
1769 return skip;
1770}
1771
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001772bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001773 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1774 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001775 bool skip = false;
1776 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001777 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1778
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001779 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1780
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001781 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001782 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001783
1784 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1785 VkExtent3D src_copy_extent = region.extent;
1786 VkExtent3D dst_copy_extent =
1787 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1788
Dave Houlton6f9059e2017-05-02 17:15:13 -06001789 bool slice_override = false;
1790 uint32_t depth_slices = 0;
1791
1792 // Special case for copying between a 1D/2D array and a 3D image
1793 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1794 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1795 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001796 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001797 slice_override = (depth_slices != 1);
1798 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1799 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001800 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001801 slice_override = (depth_slices != 1);
1802 }
1803
Dave Houltonee281a52017-12-08 13:51:02 -07001804 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001805 std::stringstream ss;
1806 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001807 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001808 HandleToUint64(command_buffer), DRAWSTATE_INVALID_IMAGE_ASPECT, "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001809 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001810
Dave Houltonee281a52017-12-08 13:51:02 -07001811 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001812 std::stringstream ss;
1813 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001814 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001815 HandleToUint64(command_buffer), DRAWSTATE_INVALID_IMAGE_ASPECT, "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001816 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001817
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001818 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001819 // No chance of mismatch if we're overriding depth slice count
1820 if (!slice_override) {
1821 // The number of depth slices in srcSubresource and dstSubresource must match
1822 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1823 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001824 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1825 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001826 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001827 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1828 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001829 if (src_slices != dst_slices) {
1830 std::stringstream ss;
1831 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1832 << "] do not match";
1833 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001834 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00118, "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06001835 }
1836 }
1837 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001838 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001839 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001840 std::stringstream ss;
1841 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1842 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001843 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001844 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00118, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001845 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001846 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001847
Dave Houltonc991cc92018-03-06 11:08:51 -07001848 // Do multiplane-specific checks, if extension enabled
1849 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1850 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
1851 }
1852
Dave Houltonf5217612018-02-02 16:18:52 -07001853 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1854 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
1855 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1856 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1857 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001858 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00112, "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07001859 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001860 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001861
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001862 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001863 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001864 std::stringstream ss;
1865 ss << "vkCmdCopyImage: pRegion[" << i
1866 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1867 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001868 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0011c, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001869 }
1870
1871 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001872 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001873 std::stringstream ss;
1874 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1875 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001876 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0011e, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001877 }
1878
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001879 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001880 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1881 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001882 std::stringstream ss;
1883 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1884 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001885 HandleToUint64(command_buffer), VALIDATION_ERROR_0a600150, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001886 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001887
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001888 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1889 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001890 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1891 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001892 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1893 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001894 HandleToUint64(command_buffer), VALIDATION_ERROR_0a60014e, "%s.", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001895 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001896
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001897 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001898 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001899 std::stringstream ss;
1900 ss << "vkCmdCopyImage: pRegions[" << i
1901 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1902 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001903 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d40, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001904 }
Dave Houltonee281a52017-12-08 13:51:02 -07001905 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001906 std::stringstream ss;
1907 ss << "vkCmdCopyImage: pRegions[" << i
1908 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1909 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001910 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d42, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001911 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001912
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001913 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1914 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001915 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001916 std::stringstream ss;
1917 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001918 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001919 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001920 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d44, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001921 }
Dave Houltonee281a52017-12-08 13:51:02 -07001922 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001923 std::stringstream ss;
1924 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001925 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001926 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001927 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d46, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001928 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001929
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001930 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1931 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1932 // 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 -07001933 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1934 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001935 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001936 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1937 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1938 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1939 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001940 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001941 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f4, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001942 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001943
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001944 // 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 -07001945 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1946 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001947 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001948 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
1949 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
1950 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
1951 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001952 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001953 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f6, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001954 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001955 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001956
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07001958 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1959 if (slice_override) src_copy_extent.depth = depth_slices;
1960 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001961 if (extent_check & x_bit) {
1962 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001963 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00120,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001965 "width [%1d].",
1966 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001967 }
1968
1969 if (extent_check & y_bit) {
1970 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001971 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00122,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001972 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001973 "height [%1d].",
1974 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001975 }
1976 if (extent_check & z_bit) {
1977 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001978 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00126,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001979 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001980 "depth [%1d].",
1981 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001982 }
1983
Dave Houltonee281a52017-12-08 13:51:02 -07001984 // Adjust dest extent if necessary
1985 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1986 if (slice_override) dst_copy_extent.depth = depth_slices;
1987
1988 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001989 if (extent_check & x_bit) {
1990 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001991 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0012c,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001992 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001993 "width [%1d].",
1994 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001995 }
1996 if (extent_check & y_bit) {
1997 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001998 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0012e,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001999 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002000 "height [%1d].",
2001 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002002 }
2003 if (extent_check & z_bit) {
2004 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002005 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00132,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002006 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002007 "depth [%1d].",
2008 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002009 }
2010
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002011 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2012 // must not overlap in memory
2013 if (src_image_state->image == dst_image_state->image) {
2014 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002015 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2016 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002017 std::stringstream ss;
2018 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2019 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002020 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f8, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002021 }
2022 }
2023 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002024 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002025
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002026 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2027 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2028 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002029 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002030 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2031 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002032 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002033 HandleToUint64(command_buffer), DRAWSTATE_MISMATCHED_IMAGE_FORMAT, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002034 }
2035 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002036 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2037 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002038 if (srcSize != destSize) {
2039 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2040 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002041 HandleToUint64(command_buffer), VALIDATION_ERROR_1900010e, "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002042 }
2043 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002044
Dave Houlton33c22b72017-02-28 13:16:02 -07002045 // Source and dest image sample counts must match
2046 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2047 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2048 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002049 HandleToUint64(command_buffer), VALIDATION_ERROR_19000110, "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002050 }
2051
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002052 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2053 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002054 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002055 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002056 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002057 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002058 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002059 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002060 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002061 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002062 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002063 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002064 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002065 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002066 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002067 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002068 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002069 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2070 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002071 }
2072
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002073 return skip;
2074}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002075
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002076void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002077 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2078 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2079 // Make sure that all image slices are updated to correct layout
2080 for (uint32_t i = 0; i < region_count; ++i) {
2081 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2082 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2083 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002084 // Update bindings between images and cmd buffer
2085 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2086 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002087 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002088 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002089 function = [=]() {
2090 SetImageMemoryValid(device_data, dst_image_state, true);
2091 return false;
2092 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002093 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002094}
2095
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002096// Returns true if sub_rect is entirely contained within rect
2097static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2098 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2099 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2100 return false;
2101 return true;
2102}
2103
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002104bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2105 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002106 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002107 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2108
2109 bool skip = false;
2110 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002111 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2112 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002113 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002114 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002115 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002116 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2117 // 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 -07002118 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2119 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002120 skip |= log_msg(
2121 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002122 HandleToUint64(commandBuffer), DRAWSTATE_CLEAR_CMD_BEFORE_DRAW,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002123 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2124 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2125 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002126 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002127 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002128 }
2129
2130 // Validate that attachment is in reference list of active subpass
2131 if (cb_node->activeRenderPass) {
2132 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2133 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002134 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002135
2136 for (uint32_t i = 0; i < attachmentCount; i++) {
2137 auto clear_desc = &pAttachments[i];
2138 VkImageView image_view = VK_NULL_HANDLE;
2139
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002140 if (0 == clear_desc->aspectMask) {
2141 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002142 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00c03, " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002143 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2144 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002145 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00028, " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002146 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002147 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002148 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002149 HandleToUint64(commandBuffer), VALIDATION_ERROR_1860001e,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002150 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d.",
2151 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002152 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2153 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002154 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -06002155 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002156 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2157 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002158 } else {
2159 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002160 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002161 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002162 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2163 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2164 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002165 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002166 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002167 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00026, str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002168 }
2169 } else { // Must be depth and/or stencil
2170 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2171 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002172 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002173 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002174 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00c01, str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002175 }
2176 if (!subpass_desc->pDepthStencilAttachment ||
2177 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2178 skip |= log_msg(
2179 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002180 HandleToUint64(commandBuffer), DRAWSTATE_MISSING_ATTACHMENT_REFERENCE,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002181 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002182 } else {
2183 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2184 }
2185 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002186 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002187 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002188 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002189 // The rectangular region specified by a given element of pRects must be contained within the render area of
2190 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002191 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2192 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2193 skip |=
2194 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002195 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600020,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002196 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002197 "the current render pass instance.",
2198 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002199 }
2200 } else {
2201 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2202 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2203 return log_msg(
2204 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002205 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600020,
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002206 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002207 "the current render pass instance.",
2208 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002209 }
2210 return false;
2211 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002212 }
2213 // The layers specified by a given element of pRects must be contained within every attachment that
2214 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002215 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002216 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2217 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002218 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002219 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600022,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002220 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002221 "of pAttachment[%d].",
2222 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002223 }
2224 }
2225 }
2226 }
2227 }
2228 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002229}
2230
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002231bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002232 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002233 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002234 bool skip = false;
2235 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002236 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2237 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2238 skip |=
2239 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002240 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002241 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002242
2243 // For each region, the number of layers in the image subresource should not be zero
2244 // For each region, src and dest image aspect must be color only
2245 for (uint32_t i = 0; i < regionCount; i++) {
2246 if (pRegions[i].srcSubresource.layerCount == 0) {
2247 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002248 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002249 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002250 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002251 if (pRegions[i].dstSubresource.layerCount == 0) {
2252 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002253 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002254 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002255 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002256 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2257 skip |= log_msg(
2258 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002259 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_0a200216,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002260 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002261 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002262 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2263 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2264 char const str[] =
2265 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2266 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002267 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_0a200214, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002268 }
2269 }
2270
2271 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2272 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002273 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002274 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_FORMAT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002275 }
2276 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2277 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002278 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002279 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_TYPE, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002280 }
2281 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2282 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2283 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002284 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_1c800202, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002285 }
2286 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2287 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2288 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002289 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_1c800206, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002290 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002291 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002292 } else {
2293 assert(0);
2294 }
2295 return skip;
2296}
2297
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002298void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2299 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002300 // Update bindings between images and cmd buffer
2301 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2302 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2303
2304 std::function<bool()> function = [=]() {
2305 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2306 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002307 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002308 function = [=]() {
2309 SetImageMemoryValid(device_data, dst_image_state, true);
2310 return false;
2311 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002312 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002313}
2314
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002315bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002316 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2317 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002318 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2319
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002320 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002321 if (cb_node) {
2322 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2323 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002324 if (cb_node && src_image_state && dst_image_state) {
2325 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002326 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002327 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002328 VALIDATION_ERROR_184001d4);
2329 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2330 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2331 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2332 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2333 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2334 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2335 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002336 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002337 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002338 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002339
Dave Houlton33c2d252017-06-09 17:08:32 -06002340 VkFormat src_format = src_image_state->createInfo.format;
2341 VkFormat dst_format = dst_image_state->createInfo.format;
2342 VkImageType src_type = src_image_state->createInfo.imageType;
2343 VkImageType dst_type = dst_image_state->createInfo.imageType;
2344
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002345 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002346 VkImageTiling tiling = src_image_state->createInfo.tiling;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002347 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002348 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2349 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002350 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b4,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002351 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature.",
2352 string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002353 }
2354
2355 if ((VK_FILTER_LINEAR == filter) &&
2356 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002357 skip |=
2358 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002359 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002360 "vkCmdBlitImage: source image format %s does not support linear filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002361 }
2362
2363 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2364 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002365 skip |=
2366 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002367 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002368 "vkCmdBlitImage: source image format %s does not support cubic filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002369 }
2370
2371 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2372 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002373 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001da,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002374 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002375 }
2376
2377 props = GetFormatProperties(device_data, dst_format);
2378 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002379 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002380 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002381 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002382 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001be,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002383 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature.",
2384 string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002385 }
2386
2387 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2388 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2389 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002390 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001c8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002391 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002392 }
2393
2394 // Validate consistency for unsigned formats
2395 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2396 std::stringstream ss;
2397 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2398 << "the other one must also have unsigned integer format. "
2399 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2400 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002401 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001cc, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002402 }
2403
2404 // Validate consistency for signed formats
2405 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2406 std::stringstream ss;
2407 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2408 << "the other one must also have signed integer format. "
2409 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2410 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002411 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ca, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002412 }
2413
2414 // Validate filter for Depth/Stencil formats
2415 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2416 std::stringstream ss;
2417 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2418 << "then filter must be VK_FILTER_NEAREST.";
2419 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002420 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d0, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002421 }
2422
2423 // Validate aspect bits and formats for depth/stencil images
2424 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2425 if (src_format != dst_format) {
2426 std::stringstream ss;
2427 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2428 << "stencil, the other one must have exactly the same format. "
2429 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2430 << string_VkFormat(dst_format);
Mark Lobodzinski88529492018-04-01 10:38:15 -06002431 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2432 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ce, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002433 }
2434
2435#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2436 for (uint32_t i = 0; i < regionCount; i++) {
2437 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2438
2439 if (FormatIsDepthAndStencil(src_format)) {
2440 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2441 std::stringstream ss;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002442 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of VK_IMAGE_ASPECT_DEPTH_BIT "
Dave Houlton33c2d252017-06-09 17:08:32 -06002443 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2444 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002445 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002446 "%s", ss.str().c_str());
2447 }
2448 }
2449 else if (FormatIsStencilOnly(src_format)) {
2450 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2451 std::stringstream ss;
2452 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2453 << "set in both the srcImage and dstImage";
2454 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002455 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002456 "%s", ss.str().c_str());
2457 }
2458 }
2459 else if (FormatIsDepthOnly(src_format)) {
2460 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2461 std::stringstream ss;
2462 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2463 << "set in both the srcImage and dstImage";
2464 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002465 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002466 "%s", ss.str().c_str());
2467 }
2468 }
2469 }
2470#endif
2471 } // Depth or Stencil
2472
2473 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002474 for (uint32_t i = 0; i < region_count; i++) {
2475 const VkImageBlit rgn = regions[i];
2476 bool hit_error = false;
2477 skip |=
2478 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2479 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2480 skip |=
2481 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2482 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002483
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002484 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002485 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2486 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002487 std::stringstream ss;
2488 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2489 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002490 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_EXTENTS, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002491 }
Dave Houlton48989f32017-05-26 15:01:46 -06002492 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2493 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002494 std::stringstream ss;
2495 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2496 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002497 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_EXTENTS, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002498 }
Dave Houlton48989f32017-05-26 15:01:46 -06002499 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002500 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2501 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002502 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002503 }
Dave Houlton48989f32017-05-26 15:01:46 -06002504 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002505 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2506 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002507 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002508 }
2509
2510 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002511 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002512 skip |=
2513 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002514 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001de,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002515 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002516 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002517
Dave Houlton48989f32017-05-26 15:01:46 -06002518 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002519 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002520 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001dc,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002521 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002522 }
Dave Houlton48989f32017-05-26 15:01:46 -06002523
Dave Houlton33c2d252017-06-09 17:08:32 -06002524 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2525 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002526 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e2,
Dave Houlton33c2d252017-06-09 17:08:32 -06002527 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002528 "image format %s.",
2529 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002530 }
2531
2532 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2533 skip |= log_msg(
2534 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002535 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e4,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002536 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
2537 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002538 }
2539
Dave Houlton48989f32017-05-26 15:01:46 -06002540 // Validate source image offsets
2541 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002542 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002543 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2544 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002545 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ea,
Dave Houlton48989f32017-05-26 15:01:46 -06002546 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002547 "of (%1d, %1d). These must be (0, 1).",
2548 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002549 }
2550 }
2551
Dave Houlton33c2d252017-06-09 17:08:32 -06002552 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002553 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2554 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002555 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ee,
Dave Houlton48989f32017-05-26 15:01:46 -06002556 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002557 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
2558 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002559 }
2560 }
2561
Dave Houlton33c2d252017-06-09 17:08:32 -06002562 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002563 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2564 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002565 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002566 skip |=
2567 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002568 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002569 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
2570 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002571 }
2572 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2573 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002574 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002575 skip |= log_msg(
2576 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002577 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002578 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
2579 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002580 }
2581 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2582 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002583 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002584 skip |=
2585 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002586 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ec,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002587 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
2588 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002589 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002590 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2591 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002592 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ae,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002593 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d.", i,
2594 rgn.srcSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002595 } else if (oob) {
2596 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002597 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ae,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002598 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06002599 }
Dave Houlton48989f32017-05-26 15:01:46 -06002600
2601 // Validate dest image offsets
2602 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002603 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002604 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2605 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002606 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f4,
Dave Houlton48989f32017-05-26 15:01:46 -06002607 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002608 "(%1d, %1d). These must be (0, 1).",
2609 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002610 }
2611 }
2612
Dave Houlton33c2d252017-06-09 17:08:32 -06002613 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002614 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2615 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002616 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f8,
Dave Houlton48989f32017-05-26 15:01:46 -06002617 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002618 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
2619 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002620 }
2621 }
2622
Dave Houlton33c2d252017-06-09 17:08:32 -06002623 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002624 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2625 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002626 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002627 skip |=
2628 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002629 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002630 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
2631 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002632 }
2633 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2634 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002635 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002636 skip |= log_msg(
2637 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002638 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f2,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002639 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
2640 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002641 }
2642 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2643 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002644 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002645 skip |=
2646 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002647 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002648 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
2649 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002650 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002651 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002652 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002653 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002654 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d.", i,
2655 rgn.dstSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002656 } else if (oob) {
2657 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002658 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002659 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002660 }
2661
Dave Houlton33c2d252017-06-09 17:08:32 -06002662 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2663 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2664 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2665 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002666 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e0,
Dave Houlton33c2d252017-06-09 17:08:32 -06002667 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002668 "layerCount other than 1.",
2669 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002670 }
2671 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002672 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002673 } else {
2674 assert(0);
2675 }
2676 return skip;
2677}
2678
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002679void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002680 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2681 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2682 // Make sure that all image slices are updated to correct layout
2683 for (uint32_t i = 0; i < region_count; ++i) {
2684 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2685 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2686 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002687 // Update bindings between images and cmd buffer
2688 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2689 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2690
2691 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002692 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002693 function = [=]() {
2694 SetImageMemoryValid(device_data, dst_image_state, true);
2695 return false;
2696 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002697 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002698}
2699
Tony Barbourdf013b92017-01-25 12:53:48 -07002700// This validates that the initial layout specified in the command buffer for
2701// the IMAGE is the same
2702// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002703bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002704 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2705 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002706 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002707 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002708 for (auto cb_image_data : pCB->imageLayoutMap) {
2709 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002710
Dave Houltonb3f4b282018-02-22 16:25:16 -07002711 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2712 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002713 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2714 // TODO: Set memory invalid which is in mem_tracker currently
2715 } else if (imageLayout != cb_image_data.second.initialLayout) {
2716 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002717 skip |= log_msg(
2718 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002719 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002720 "Cannot submit cmd buffer using image (0x%" PRIx64
2721 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2722 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2723 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2724 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002725 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002726 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002727 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002728 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002729 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2730 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002731 }
2732 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002733 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002734 }
2735 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002736 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002737}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002738
Tony Barbourdf013b92017-01-25 12:53:48 -07002739void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2740 for (auto cb_image_data : pCB->imageLayoutMap) {
2741 VkImageLayout imageLayout;
2742 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2743 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2744 }
2745}
2746
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002747// Print readable FlagBits in FlagMask
2748static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2749 std::string result;
2750 std::string separator;
2751
2752 if (accessMask == 0) {
2753 result = "[None]";
2754 } else {
2755 result = "[";
2756 for (auto i = 0; i < 32; i++) {
2757 if (accessMask & (1 << i)) {
2758 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2759 separator = " | ";
2760 }
2761 }
2762 result = result + "]";
2763 }
2764 return result;
2765}
2766
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002767// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2768// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002769// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002770static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2771 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2772 const char *type) {
2773 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2774 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002775
2776 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2777 if (accessMask & ~(required_bit | optional_bits)) {
2778 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002779 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002780 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002781 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2782 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002783 }
2784 } else {
2785 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002786 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002787 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002788 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
2789 "has previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002790 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2791 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002792 } else {
2793 std::string opt_bits;
2794 if (optional_bits != 0) {
2795 std::stringstream ss;
2796 ss << optional_bits;
2797 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2798 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002799 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002800 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002801 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
2802 "previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002803 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2804 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002805 }
2806 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002807 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002808}
2809
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002810// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002811// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2812// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002813bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002814 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2815 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002816 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2817 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2818 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2819 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002820 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002821 VALIDATION_ERROR_12200688, "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002822 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002823 }
2824 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002825 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002826}
2827
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002828bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2829 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002830 bool skip = false;
2831
Jason Ekstranda1906302017-12-03 20:16:32 -08002832 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2833 VkFormat format = pCreateInfo->pAttachments[i].format;
2834 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2835 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2836 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002837 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002838 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002839 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
2840 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2841 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2842 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002843 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07002844 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002845 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002846 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002847 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
2848 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2849 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2850 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002851 }
2852 }
2853 }
2854
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002855 // Track when we're observing the first use of an attachment
2856 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2857 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2858 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002859
2860 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2861 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2862 auto attach_index = subpass.pInputAttachments[j].attachment;
2863 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2864
2865 switch (subpass.pInputAttachments[j].layout) {
2866 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2867 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2868 // These are ideal.
2869 break;
2870
2871 case VK_IMAGE_LAYOUT_GENERAL:
2872 // May not be optimal. TODO: reconsider this warning based on other constraints.
2873 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002874 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Cort Stratton7547f772017-05-04 15:18:52 -07002875 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2876 break;
2877
2878 default:
2879 // No other layouts are acceptable
2880 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002881 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Cort Stratton7547f772017-05-04 15:18:52 -07002882 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2883 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2884 }
2885
2886 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2887 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2888 subpass.pDepthStencilAttachment->attachment == attach_index &&
2889 subpass.pDepthStencilAttachment->layout != layout;
2890 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2891 found_layout_mismatch =
2892 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2893 }
2894 if (found_layout_mismatch) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002895 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002896 VALIDATION_ERROR_140006ae,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002897 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002898 "depth/color attachment with a different layout.",
2899 i, j, attach_index, layout);
Cort Stratton7547f772017-05-04 15:18:52 -07002900 }
2901
2902 if (attach_first_use[attach_index]) {
2903 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2904 pCreateInfo->pAttachments[attach_index]);
2905
2906 bool used_as_depth =
2907 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2908 bool used_as_color = false;
2909 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2910 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2911 }
2912 if (!used_as_depth && !used_as_color &&
2913 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2914 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002915 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002916 VALIDATION_ERROR_1400069c,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002917 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
2918 attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07002919 }
2920 }
2921 attach_first_use[attach_index] = false;
2922 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002923 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2924 auto attach_index = subpass.pColorAttachments[j].attachment;
2925 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2926
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002927 // TODO: Need a way to validate shared presentable images here, currently just allowing
2928 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2929 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002930 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002931 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002932 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002933 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2934 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002935 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002936
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002937 case VK_IMAGE_LAYOUT_GENERAL:
2938 // May not be optimal; TODO: reconsider this warning based on other constraints?
2939 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002940 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002941 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2942 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002943
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002944 default:
2945 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002946 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002947 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2948 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002949 }
2950
2951 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002952 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2953 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002954 }
2955 attach_first_use[attach_index] = false;
2956 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06002957
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002958 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2959 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002960 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2961 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2962 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06002963 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06002964
Dave Houltona9df0ce2018-02-07 10:51:23 -07002965 case VK_IMAGE_LAYOUT_GENERAL:
2966 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2967 // doing a bunch of transitions.
2968 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002969 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002970 "GENERAL layout for depth attachment may not give optimal performance.");
2971 break;
2972
2973 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
2974 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
2975 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
2976 break;
2977 } else {
2978 // Intentionally fall through to generic error message
2979 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002980 // fall through
Dave Houltona9df0ce2018-02-07 10:51:23 -07002981 default:
2982 // No other layouts are acceptable
2983 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002984 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002985 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2986 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2987 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002988 }
2989
2990 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2991 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002992 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2993 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002994 }
2995 attach_first_use[attach_index] = false;
2996 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002997 }
2998 return skip;
2999}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003000
3001// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003002bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3003 VkDeviceSize offset, VkDeviceSize end_offset) {
3004 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3005 bool skip = false;
3006 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3007 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003008 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3009 for (auto image_handle : mem_info->bound_images) {
3010 auto img_it = mem_info->bound_ranges.find(image_handle);
3011 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003012 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003013 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003014 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003015 for (auto layout : layouts) {
3016 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003017 skip |=
3018 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003019 HandleToUint64(mem_info->mem), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003020 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3021 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003022 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003023 }
3024 }
3025 }
3026 }
3027 }
3028 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003029 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003030}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003031
3032// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3033// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003034static bool validate_usage_flags(layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
Mark Lobodzinski33826372017-04-13 11:10:11 -06003035 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003036 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003037
3038 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003039 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003040 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003041 if (strict) {
3042 correct_usage = ((actual & desired) == desired);
3043 } else {
3044 correct_usage = ((actual & desired) != 0);
3045 }
3046 if (!correct_usage) {
3047 if (msgCode == -1) {
3048 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003049 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003050 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003051 MEMTRACK_INVALID_USAGE_FLAG,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003052 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3053 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003054 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003055 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003056 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 -06003057 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3058 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003059 }
3060 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003061 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003062}
3063
3064// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3065// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003066bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003067 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003068 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3069 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003070}
3071
3072// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3073// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003074bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003075 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003076 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3077 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003078}
3079
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003080bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003081 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003082 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3083
Chris Forbese0f511c2017-06-14 12:38:01 -07003084 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003085
3086 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003087 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003088 VALIDATION_ERROR_01400726,
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003089 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003090 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003091 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003092
3093 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003094 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003095 VALIDATION_ERROR_01400728,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003096 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003097 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003098 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003099
3100 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003101 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003102 VALIDATION_ERROR_0140072a,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003103 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003104 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003105 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003106 return skip;
3107}
3108
3109void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3110 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3111 GetBufferMap(device_data)
3112 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3113}
3114
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003115bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3116 bool skip = false;
3117 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003118 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3119 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003120 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003121 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3122 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003123 skip |= ValidateBufferUsageFlags(
3124 device_data, buffer_state, VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003125 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003126 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003127 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003128}
3129
3130void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3131 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3132}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003133
3134// For the given format verify that the aspect masks make sense
3135bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3136 const char *func_name) {
3137 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3138 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003139 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003140 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003141 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 -06003142 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003143 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003144 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003145 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 -06003146 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003147 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003148 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003149 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003150 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003151 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 -06003152 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003153 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003154 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3155 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003156 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003157 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 -06003158 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003159 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003160 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3161 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003162 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003163 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003164 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003165 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 -06003166 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003167 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003168 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003169 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 -06003170 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003171 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003172 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003173 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003174 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003175 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 -06003176 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003177 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003178 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003179 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 -06003180 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003181 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003182 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003183 } else if (FormatIsMultiplane(format)) {
3184 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3185 if (3 == FormatPlaneCount(format)) {
3186 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3187 }
3188 if ((aspect_mask & valid_flags) != aspect_mask) {
3189 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3190 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
3191 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3192 "set, where n = [0, 1, 2].",
3193 func_name);
3194 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003195 }
3196 return skip;
3197}
3198
Petr Krausffa94af2017-08-08 21:46:02 +02003199struct SubresourceRangeErrorCodes {
3200 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3201};
3202
3203bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3204 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3205 const char *image_layer_count_var_name, const uint64_t image_handle,
3206 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003207 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3208 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003209
3210 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003211 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003212 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 -06003213 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003214 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003215 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3216 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003217 }
Petr Kraus4d718682017-05-18 03:38:41 +02003218
Petr Krausffa94af2017-08-08 21:46:02 +02003219 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3220 if (subresourceRange.levelCount == 0) {
3221 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 -06003222 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003223 } else {
3224 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003225
Petr Krausffa94af2017-08-08 21:46:02 +02003226 if (necessary_mip_count > image_mip_count) {
3227 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 -06003228 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003229 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003230 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003231 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003232 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003233 }
Petr Kraus4d718682017-05-18 03:38:41 +02003234 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003235 }
Petr Kraus4d718682017-05-18 03:38:41 +02003236
3237 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003238 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003239 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 -06003240 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003241 "%s: %s.baseArrayLayer (= %" PRIu32
3242 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3243 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003244 }
Petr Kraus4d718682017-05-18 03:38:41 +02003245
Petr Krausffa94af2017-08-08 21:46:02 +02003246 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3247 if (subresourceRange.layerCount == 0) {
3248 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 -06003249 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003250 } else {
3251 const uint64_t necessary_layer_count =
3252 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003253
Petr Krausffa94af2017-08-08 21:46:02 +02003254 if (necessary_layer_count > image_layer_count) {
3255 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 -06003256 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003257 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003258 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003259 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003260 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003261 }
Petr Kraus4d718682017-05-18 03:38:41 +02003262 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003263 }
Petr Kraus4d718682017-05-18 03:38:41 +02003264
Mark Lobodzinski602de982017-02-09 11:01:33 -07003265 return skip;
3266}
3267
Petr Krausffa94af2017-08-08 21:46:02 +02003268bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3269 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3270 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3271 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3272 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3273 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3274
3275 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3276 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3277
3278 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3279 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003280 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00d6c;
Petr Krausffa94af2017-08-08 21:46:02 +02003281 subresourceRangeErrorCodes.base_layer_err =
3282 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3283 subresourceRangeErrorCodes.layer_count_err =
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003284 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00d6e;
Petr Krausffa94af2017-08-08 21:46:02 +02003285
3286 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3287 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3288 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3289}
3290
3291bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3292 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3293 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3294 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003295 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800d38;
Petr Krausffa94af2017-08-08 21:46:02 +02003296 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003297 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800d3a;
Petr Krausffa94af2017-08-08 21:46:02 +02003298
3299 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3300 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3301 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3302}
3303
3304bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3305 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3306 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3307 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003308 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00d3c;
Petr Krausffa94af2017-08-08 21:46:02 +02003309 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003310 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00d3e;
Petr Krausffa94af2017-08-08 21:46:02 +02003311
3312 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3313 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3314 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3315}
3316
3317bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3318 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3319 const char *param_name) {
3320 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3321 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003322 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000d78;
Petr Krausffa94af2017-08-08 21:46:02 +02003323 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003324 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000d7a;
Petr Krausffa94af2017-08-08 21:46:02 +02003325
3326 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3327 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3328 subresourceRangeErrorCodes);
3329}
3330
Mark Lobodzinski602de982017-02-09 11:01:33 -07003331bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3332 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3333 bool skip = false;
3334 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3335 if (image_state) {
3336 skip |= ValidateImageUsageFlags(
3337 device_data, image_state,
3338 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houltona9df0ce2018-02-07 10:51:23 -07003339 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003340 false, -1, "vkCreateImageView()",
3341 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3342 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003343 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003344 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003345 skip |= ValidateCreateImageViewSubresourceRange(
3346 device_data, image_state,
3347 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3348 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003349
3350 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3351 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003352 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3353 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003354 VkFormat view_format = create_info->format;
3355 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003356 VkImageType image_type = image_state->createInfo.imageType;
3357 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003358
Dave Houltonbd2e2622018-04-10 16:41:14 -06003359 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
3360 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
3361 if (chained_ivuci_struct) {
3362 if (chained_ivuci_struct->usage & ~image_usage) {
3363 std::stringstream ss;
3364 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06003365 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06003366 << image_usage << ").";
3367 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3368 VALIDATION_ERROR_3f200c66, "%s", ss.str().c_str());
3369 }
3370
3371 image_usage = chained_ivuci_struct->usage;
3372 }
3373
Mark Lobodzinski602de982017-02-09 11:01:33 -07003374 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3375 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003376 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3377 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3378 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3379 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3380 std::stringstream ss;
3381 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3382 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3383 << ") format " << string_VkFormat(image_format)
3384 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3385 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3386 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003387 VALIDATION_ERROR_0ac007f4, "%s", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06003388 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003389 }
3390 } else {
3391 // Format MUST be IDENTICAL to the format the image was created with
3392 if (image_format != view_format) {
3393 std::stringstream ss;
3394 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003395 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003396 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003397 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003398 VALIDATION_ERROR_0ac007f6, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07003399 }
3400 }
3401
3402 // Validate correct image aspect bits for desired formats and format consistency
3403 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003404
3405 switch (image_type) {
3406 case VK_IMAGE_TYPE_1D:
3407 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3408 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003409 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003410 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3411 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003412 }
3413 break;
3414 case VK_IMAGE_TYPE_2D:
3415 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3416 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3417 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3418 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003419 VALIDATION_ERROR_0ac007d6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003420 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3421 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003422 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3423 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003424 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003425 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3426 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003427 }
3428 }
3429 break;
3430 case VK_IMAGE_TYPE_3D:
3431 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3432 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3433 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3434 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003435 skip |=
3436 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003437 VALIDATION_ERROR_0ac007da,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003438 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3439 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003440 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3441 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003442 skip |=
3443 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003444 VALIDATION_ERROR_0ac007fa,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003445 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3446 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003447 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
3448 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003449 }
3450 } else {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003451 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003452 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003453 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3454 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003455 }
3456 }
3457 } else {
3458 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3459 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003460 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003461 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3462 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003463 }
3464 }
3465 break;
3466 default:
3467 break;
3468 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003469
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003470 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003471 bool check_tiling_features = false;
3472 VkFormatFeatureFlags tiling_features = 0;
3473 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3474 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3475 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3476 };
3477 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3478 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3479 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3480 };
3481 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3482 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003483 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003484 error_codes = linear_error_codes;
3485 check_tiling_features = true;
3486 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003487 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003488 error_codes = optimal_error_codes;
3489 check_tiling_features = true;
3490 }
3491
3492 if (check_tiling_features) {
3493 if (tiling_features == 0) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003494 skip |=
3495 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[0],
3496 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set.",
3497 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003498 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003499 skip |=
3500 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[1],
3501 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3502 "VK_IMAGE_USAGE_SAMPLED_BIT flags set.",
3503 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003504 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003505 skip |=
3506 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[2],
3507 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3508 "VK_IMAGE_USAGE_STORAGE_BIT flags set.",
3509 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003510 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3511 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003512 skip |=
3513 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[3],
3514 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3515 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set.",
3516 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003517 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3518 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003519 skip |=
3520 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[4],
3521 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3522 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set.",
3523 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003524 }
3525 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003526 }
3527 return skip;
3528}
3529
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003530void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3531 auto image_view_map = GetImageViewMap(device_data);
3532 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3533
3534 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003535 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003536 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3537 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003538}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003539
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003540bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3541 BUFFER_STATE *dst_buffer_state) {
3542 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003543 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3544 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003545 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003546 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3547 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3548 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3549 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003550 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003551 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003552 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003553 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003554 return skip;
3555}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003556
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003557void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3558 BUFFER_STATE *dst_buffer_state) {
3559 // Update bindings between buffers and cmd buffer
3560 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3561 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3562
3563 std::function<bool()> function = [=]() {
3564 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3565 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003566 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003567 function = [=]() {
3568 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3569 return false;
3570 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003571 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003572}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003573
3574static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3575 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3576 bool skip = false;
3577 auto buffer_state = GetBufferState(device_data, buffer);
3578 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003579 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -06003580 DRAWSTATE_DOUBLE_DESTROY, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01003581 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003582 } else {
3583 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003584 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003585 HandleToUint64(buffer), VALIDATION_ERROR_23c00734,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003586 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003587 }
3588 }
3589 return skip;
3590}
3591
3592bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3593 VK_OBJECT *obj_struct) {
3594 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003595 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003596 if (GetDisables(device_data)->destroy_image_view) return false;
3597 bool skip = false;
3598 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003599 skip |=
3600 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003601 }
3602 return skip;
3603}
3604
3605void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3606 VK_OBJECT obj_struct) {
3607 // Any bound cmd buffers are now invalid
3608 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3609 (*GetImageViewMap(device_data)).erase(image_view);
3610}
3611
3612bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3613 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003614 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003615 if (GetDisables(device_data)->destroy_buffer) return false;
3616 bool skip = false;
3617 if (*buffer_state) {
3618 skip |= validateIdleBuffer(device_data, buffer);
3619 }
3620 return skip;
3621}
3622
3623void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3624 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3625 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3626 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3627 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003628 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003629 }
3630 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003631 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003632 GetBufferMap(device_data)->erase(buffer_state->buffer);
3633}
3634
3635bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3636 VK_OBJECT *obj_struct) {
3637 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003638 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003639 if (GetDisables(device_data)->destroy_buffer_view) return false;
3640 bool skip = false;
3641 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003642 skip |=
3643 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003644 }
3645 return skip;
3646}
3647
3648void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3649 VK_OBJECT obj_struct) {
3650 // Any bound cmd buffers are now invalid
3651 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3652 GetBufferViewMap(device_data)->erase(buffer_view);
3653}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003654
3655bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3656 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003657 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003658 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003659 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003660 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3661 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003662 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003663 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003664 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003665 return skip;
3666}
3667
3668void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3669 std::function<bool()> function = [=]() {
3670 SetBufferMemoryValid(device_data, buffer_state, true);
3671 return false;
3672 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003673 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003674 // Update bindings between buffer and cmd buffer
3675 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003676}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003677
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003678bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3679 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003680 bool skip = false;
3681
3682 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003683 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3684 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003685 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 -06003686 HandleToUint64(image_state->image), VALIDATION_ERROR_0160018e,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003687 "%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 -06003688 "and 1, respectively.",
3689 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003690 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003691 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003692
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003693 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3694 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003695 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 -06003696 HandleToUint64(image_state->image), VALIDATION_ERROR_01600192,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003697 "%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 -06003698 "must be 0 and 1, respectively.",
3699 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003700 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003701 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003702
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003703 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3704 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003705 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 -06003706 HandleToUint64(image_state->image), VALIDATION_ERROR_016001aa,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003707 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
3708 "For 3D images these must be 0 and 1, respectively.",
3709 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003710 }
3711 }
3712
3713 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3714 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003715 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003716 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003717 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 -06003718 HandleToUint64(image_state->image), VALIDATION_ERROR_01600182,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003719 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003720 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
3721 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003722 }
3723
3724 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003725 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003726 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 -06003727 HandleToUint64(image_state->image), VALIDATION_ERROR_01600184,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003728 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
3729 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003730 }
3731
3732 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3733 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003734 skip |=
3735 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003736 HandleToUint64(image_state->image), VALIDATION_ERROR_01600186,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003737 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
3738 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003739 }
3740
3741 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3742 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3743 skip |= log_msg(
3744 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003745 HandleToUint64(image_state->image), VALIDATION_ERROR_01600188,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003746 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
3747 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003748 }
3749
3750 // subresource aspectMask must have exactly 1 bit set
3751 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3752 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3753 if (aspect_mask_bits.count() != 1) {
3754 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 -06003755 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003756 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003757 }
3758
3759 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003760 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003761 skip |= log_msg(
3762 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003763 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003764 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
3765 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003766 }
3767
3768 // Checks that apply only to compressed images
3769 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3770 // reserves a place for these compressed image checks. This block of code could move there once the image
3771 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003772 if (FormatIsCompressed(image_state->createInfo.format)) {
3773 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003774
3775 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003776 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003777 skip |= log_msg(
3778 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003779 HandleToUint64(image_state->image), VALIDATION_ERROR_01600196,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003780 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
3781 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003782 }
3783
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003784 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003785 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003786 skip |= log_msg(
3787 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003788 HandleToUint64(image_state->image), VALIDATION_ERROR_01600198,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003789 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
3790 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003791 }
3792
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003793 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003794 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3795 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3796 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003797 skip |=
3798 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003799 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019a,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003800 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3801 "width & height (%d, %d)..",
3802 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003803 }
3804
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003805 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003806 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3807 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003808 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 -06003809 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019c,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003810 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3811 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
3812 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003813 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003814
3815 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003816 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003817 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003818 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3819 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 -06003820 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019e,
Dave Houlton75967fc2017-03-06 17:21:16 -07003821 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003822 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003823 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003824 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07003825 }
3826
3827 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003828 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003829 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3830 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 -06003831 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a0,
Dave Houlton75967fc2017-03-06 17:21:16 -07003832 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003833 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003834 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003835 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07003836 }
3837
3838 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003839 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003840 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3841 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 -06003842 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a2,
Dave Houlton75967fc2017-03-06 17:21:16 -07003843 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003844 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003845 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003846 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07003847 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003848 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003849 }
3850
3851 return skip;
3852}
3853
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003854static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3855 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003856 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003857 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003858
3859 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003860 VkExtent3D extent = pRegions[i].imageExtent;
3861 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003862
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003863 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3864 {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003865 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3866 (uint64_t)0, IMAGE_ZERO_AREA_SUBREGION, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
3867 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003868 }
3869
3870 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3871
3872 // 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 -06003873 if (FormatIsCompressed(image_info->format)) {
3874 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003875 if (image_extent.width % block_extent.width) {
3876 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3877 }
3878 if (image_extent.height % block_extent.height) {
3879 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3880 }
3881 if (image_extent.depth % block_extent.depth) {
3882 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3883 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003884 }
3885
Dave Houltonfc1a4052017-04-27 14:32:45 -06003886 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003887 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 -06003888 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003889 }
3890 }
3891
3892 return skip;
3893}
3894
Chris Forbese8ba09a2017-06-01 17:39:02 -07003895static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003896 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3897 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003898 bool skip = false;
3899
3900 VkDeviceSize buffer_size = buff_state->createInfo.size;
3901
3902 for (uint32_t i = 0; i < regionCount; i++) {
3903 VkExtent3D copy_extent = pRegions[i].imageExtent;
3904
3905 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3906 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003907 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003908
Dave Houltonf3229d52017-02-21 15:59:08 -07003909 // Handle special buffer packing rules for specific depth/stencil formats
3910 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003911 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003912 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3913 switch (image_state->createInfo.format) {
3914 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003915 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003916 break;
3917 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003918 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003919 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003920 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003921 case VK_FORMAT_D24_UNORM_S8_UINT:
3922 unit_size = 4;
3923 break;
3924 default:
3925 break;
3926 }
3927 }
3928
Dave Houlton1d2022c2017-03-29 11:43:58 -06003929 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003930 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003931 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003932 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3933 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3934
3935 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3936 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3937 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003938 }
3939
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003940 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3941 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3942 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003943 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003944 } else {
3945 // Calculate buffer offset of final copied byte, + 1.
3946 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3947 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3948 max_buffer_offset *= unit_size; // convert to bytes
3949 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003950
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003951 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003952 skip |=
3953 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
3954 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003955 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003956 }
3957 }
3958
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003959 return skip;
3960}
3961
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003962bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003963 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003964 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003965 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3966 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
3967
3968 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07003969 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003970
3971 // Command pool must support graphics, compute, or transfer operations
3972 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3973
3974 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3975 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3976 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003977 HandleToUint64(cb_node->createInfo.commandPool), VALIDATION_ERROR_19202415,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003978 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003979 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003980 }
Dave Houlton0ef27492018-04-04 11:41:48 -06003981 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003982 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07003983 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06003984 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003985
3986 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003987 VALIDATION_ERROR_19200178);
3988 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
3989 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003990
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003991 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003992 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003993 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003994 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3995 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
3996 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003997 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003998 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003999 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
4000 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
4001 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004002 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06004003 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004004 }
4005 return skip;
4006}
4007
4008void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004009 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4010 VkImageLayout src_image_layout) {
4011 // Make sure that all image slices are updated to correct layout
4012 for (uint32_t i = 0; i < region_count; ++i) {
4013 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4014 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004015 // Update bindings between buffer/image and cmd buffer
4016 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004017 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004018
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004019 std::function<bool()> function = [=]() {
4020 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
4021 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004022 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004023 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004024 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004025 return false;
4026 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004027 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004028}
4029
4030bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004031 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004032 const VkBufferImageCopy *pRegions, const char *func_name) {
4033 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4034 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4035
4036 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004037 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004038
4039 // Command pool must support graphics, compute, or transfer operations
4040 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4041 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4042 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4043 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004044 HandleToUint64(cb_node->createInfo.commandPool), VALIDATION_ERROR_18e02415,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004045 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004046 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004047 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004048 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004049 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004050 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004051 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004052 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004053 VALIDATION_ERROR_18e00166);
4054 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4055 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4056 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4057 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4058 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004059 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004060 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004061 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004062 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004063 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4064 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4065 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004066 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4067 "vkCmdCopyBufferToImage()");
4068 }
4069 return skip;
4070}
4071
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004072void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004073 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4074 VkImageLayout dst_image_layout) {
4075 // Make sure that all image slices are updated to correct layout
4076 for (uint32_t i = 0; i < region_count; ++i) {
4077 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4078 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004079 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004080 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004081 std::function<bool()> function = [=]() {
4082 SetImageMemoryValid(device_data, dst_image_state, true);
4083 return false;
4084 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004085 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004086 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004087 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004088}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004089
4090bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4091 const auto report_data = core_validation::GetReportData(device_data);
4092 bool skip = false;
4093 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4094
Dave Houlton1d960ff2018-01-19 12:17:05 -07004095 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004096 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4097 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4098 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004099 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Mark Lobodzinski88529492018-04-01 10:38:15 -06004100 VALIDATION_ERROR_2a6007ca,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004101 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004102 }
4103
4104 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4105 if (!image_entry) {
4106 return skip;
4107 }
4108
Dave Houlton1d960ff2018-01-19 12:17:05 -07004109 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004110 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004111 skip |=
4112 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4113 VALIDATION_ERROR_2a6007c8, "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004114 }
4115
Dave Houlton1d960ff2018-01-19 12:17:05 -07004116 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004117 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004118 skip |=
4119 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4120 VALIDATION_ERROR_2a600d68, "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.",
4121 pSubresource->mipLevel, image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004122 }
4123
Dave Houlton1d960ff2018-01-19 12:17:05 -07004124 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004125 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004126 skip |=
4127 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4128 VALIDATION_ERROR_2a600d6a, "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4129 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004130 }
4131
Dave Houlton1d960ff2018-01-19 12:17:05 -07004132 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004133 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004134 if (FormatIsMultiplane(img_format)) {
4135 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4136 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4137 if (FormatPlaneCount(img_format) > 2u) {
4138 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4139 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4140 }
4141 if (sub_aspect != (sub_aspect & allowed_flags)) {
4142 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 -06004143 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004144 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004145 ") must be a single-plane specifier flag.",
4146 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004147 }
4148 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004149 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004150 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004151 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Mark Lobodzinski88529492018-04-01 10:38:15 -06004152 VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004153 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004154 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004155 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004156 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004157 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 -06004158 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mike Weiblen672b58b2017-02-21 14:32:53 -07004159 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004160 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004161 }
4162 }
4163 return skip;
4164}