blob: 8fbdfe30fdd531f3d1aafb55dee1091d7eda63e2 [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"
32
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070033#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070034
Tobin Ehlis58c884f2017-02-08 12:15:27 -070035void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070036 auto it = pCB->imageLayoutMap.find(imgpair);
37 if (it != pCB->imageLayoutMap.end()) {
38 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070039 } else {
40 assert(imgpair.hasSubresource);
41 IMAGE_CMD_BUF_LAYOUT_NODE node;
42 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
43 node.initialLayout = layout;
44 }
45 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
46 }
47}
48template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070049void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070050 ImageSubresourcePair imgpair = {image, true, range};
51 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
52 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
53 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
54 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -070055 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
56 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
57 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
58 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
59 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070060}
61
62template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070063void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070064 VkImageAspectFlags aspectMask) {
65 if (imgpair.subresource.aspectMask & aspectMask) {
66 imgpair.subresource.aspectMask = aspectMask;
67 SetLayout(device_data, pObject, imgpair, layout);
68 }
69}
70
Tony Barbourdf013b92017-01-25 12:53:48 -070071// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070072void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
73 VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070074 auto it = imageLayoutMap.find(imgpair);
75 if (it != imageLayoutMap.end()) {
76 it->second.layout = layout; // Update
77 } else {
78 imageLayoutMap[imgpair].layout = layout; // Insert
79 }
Tony Barbourdf013b92017-01-25 12:53:48 -070080}
81
Tobin Ehlisc8266452017-04-07 12:20:30 -060082bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070083 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
84 const debug_report_data *report_data = core_validation::GetReportData(device_data);
85
86 if (!(imgpair.subresource.aspectMask & aspectMask)) {
87 return false;
88 }
89 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
90 imgpair.subresource.aspectMask = aspectMask;
91 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
92 if (imgsubIt == pCB->imageLayoutMap.end()) {
93 return false;
94 }
95 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +020096 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 -060097 DRAWSTATE_INVALID_LAYOUT,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070098 "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 +020099 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700100 string_VkImageLayout(imgsubIt->second.layout));
101 }
102 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200103 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 -0600104 DRAWSTATE_INVALID_LAYOUT,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700105 "Cannot query for VkImage 0x%" PRIx64
106 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200107 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700108 string_VkImageLayout(imgsubIt->second.initialLayout));
109 }
110 node = imgsubIt->second;
111 return true;
112}
113
Tobin Ehlisc8266452017-04-07 12:20:30 -0600114bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700115 const VkImageAspectFlags aspectMask) {
116 if (!(imgpair.subresource.aspectMask & aspectMask)) {
117 return false;
118 }
119 const debug_report_data *report_data = core_validation::GetReportData(device_data);
120 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
121 imgpair.subresource.aspectMask = aspectMask;
122 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
123 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
124 return false;
125 }
126 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200127 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 -0600128 DRAWSTATE_INVALID_LAYOUT,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700129 "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 +0200130 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700131 string_VkImageLayout(imgsubIt->second.layout));
132 }
133 layout = imgsubIt->second.layout;
134 return true;
135}
136
137// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600138bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700139 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
140 ImageSubresourcePair imgpair = {image, true, range};
141 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
142 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
143 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
144 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
145 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700146 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
147 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
148 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
149 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
150 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700151 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
152 imgpair = {image, false, VkImageSubresource()};
153 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
154 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
155 // TODO: This is ostensibly a find function but it changes state here
156 node = imgsubIt->second;
157 }
158 return true;
159}
160
161// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700162bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700163 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
164 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
165 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
166 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
167 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700168 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
169 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
170 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
171 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
172 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700173 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
174 imgpair = {imgpair.image, false, VkImageSubresource()};
175 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
176 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
177 layout = imgsubIt->second.layout;
178 }
179 return true;
180}
181
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700182bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700183 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
184 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700185 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700186 if (!image_state) return false;
187 bool ignoreGlobal = false;
188 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
189 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
190 ignoreGlobal = true;
191 }
192 for (auto imgsubpair : sub_data->second) {
193 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
194 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
195 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
196 layouts.push_back(img_data->second.layout);
197 }
198 }
199 return true;
200}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700201bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
202 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700203 if (!(imgpair.subresource.aspectMask & aspectMask)) {
204 return false;
205 }
206 imgpair.subresource.aspectMask = aspectMask;
207 auto imgsubIt = imageLayoutMap.find(imgpair);
208 if (imgsubIt == imageLayoutMap.end()) {
209 return false;
210 }
211 layout = imgsubIt->second.layout;
212 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700213}
Tony Barbourdf013b92017-01-25 12:53:48 -0700214
215// find layout in supplied map
Dave Houltonb3f4b282018-02-22 16:25:16 -0700216bool FindLayout(layer_data *device_data, const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
217 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700218 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
219 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
220 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
221 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
222 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700223 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
224 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
225 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
226 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
227 }
228 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700229 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
230 imgpair = {imgpair.image, false, VkImageSubresource()};
231 auto imgsubIt = imageLayoutMap.find(imgpair);
232 if (imgsubIt == imageLayoutMap.end()) return false;
233 layout = imgsubIt->second.layout;
234 }
235 return true;
236}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700237
238// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700239void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700240 VkImage &image = imgpair.image;
Dave Houltonb3f4b282018-02-22 16:25:16 -0700241 auto &lmap = (*core_validation::GetImageLayoutMap(device_data));
242 auto data = lmap.find(imgpair);
243 if (data != lmap.end()) {
244 data->second.layout = layout; // Update
245 } else {
246 lmap[imgpair].layout = layout; // Insert
247 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700248 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
249 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
250 if (subresource == image_subresources.end()) {
251 image_subresources.push_back(imgpair);
252 }
253}
254
255// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700256void 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 -0700257 auto it = pCB->imageLayoutMap.find(imgpair);
258 if (it != pCB->imageLayoutMap.end()) {
259 it->second = node; // Update
260 } else {
261 pCB->imageLayoutMap[imgpair] = node; // Insert
262 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700263}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600264// Set image layout for given VkImageSubresourceRange struct
265void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
266 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
267 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700268 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600269 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
270 uint32_t level = image_subresource_range.baseMipLevel + level_index;
271 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
272 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
273 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700274 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
275 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600276 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600277 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700278 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
279 }
280 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600281 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700282 }
283 }
284}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600285// Set image layout for given VkImageSubresourceLayers struct
286void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
287 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
288 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
289 VkImageSubresourceRange image_subresource_range;
290 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
291 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
292 image_subresource_range.layerCount = image_subresource_layers.layerCount;
293 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
294 image_subresource_range.levelCount = 1;
295 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
296}
297// Set image layout for all slices of an image view
298void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
299 auto view_state = GetImageViewState(device_data, imageView);
300 assert(view_state);
301
302 SetImageLayout(device_data, cb_node, GetImageState(device_data, view_state->create_info.image),
303 view_state->create_info.subresourceRange, layout);
304}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700305
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700306bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700307 const VkRenderPassBeginInfo *pRenderPassBegin,
308 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600309 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700310 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700311 auto const &framebufferInfo = framebuffer_state->createInfo;
312 const auto report_data = core_validation::GetReportData(device_data);
313 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600314 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 -0600315 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700316 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700317 }
318 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
319 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700320 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700321 assert(view_state);
322 const VkImage &image = view_state->create_info.image;
323 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700324 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700325 // TODO: Do not iterate over every possibility - consolidate where possible
326 for (uint32_t j = 0; j < subRange.levelCount; j++) {
327 uint32_t level = subRange.baseMipLevel + j;
328 for (uint32_t k = 0; k < subRange.layerCount; k++) {
329 uint32_t layer = subRange.baseArrayLayer + k;
330 VkImageSubresource sub = {subRange.aspectMask, level, layer};
331 IMAGE_CMD_BUF_LAYOUT_NODE node;
332 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700333 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700334 continue;
335 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700336 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600337 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 -0600338 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700339 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
340 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
341 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600342 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700343 }
344 }
345 }
346 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600347 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700348}
349
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700350void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700351 VkAttachmentReference ref) {
352 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
353 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
354 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
355 }
356}
357
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700358void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700359 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700360 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700361
362 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700363 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700364 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
365 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
366 }
367 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
368 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
369 }
370 if (subpass.pDepthStencilAttachment) {
371 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
372 }
373 }
374}
375
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600376bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700377 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700378 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
379 return false;
380 }
381 VkImageSubresource sub = {aspect, level, layer};
382 IMAGE_CMD_BUF_LAYOUT_NODE node;
383 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700384 return false;
385 }
386 bool skip = false;
387 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
388 // TODO: Set memory invalid which is in mem_tracker currently
389 } else if (node.layout != mem_barrier->oldLayout) {
Petr Kraus13c98a62017-12-09 00:22:39 +0100390 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600391 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -0600392 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Petr Kraus13c98a62017-12-09 00:22:39 +0100393 "For image 0x%" PRIx64 " you cannot transition the layout of aspect %d from %s when current layout is %s.",
394 HandleToUint64(mem_barrier->image), aspect, string_VkImageLayout(mem_barrier->oldLayout),
395 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700396 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700397 return skip;
398}
399
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700400// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
401// 1. Transition into initialLayout state
402// 2. Transition from initialLayout to layout used in subpass 0
403void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
404 FRAMEBUFFER_STATE *framebuffer_state) {
405 // First transition into initialLayout
406 auto const rpci = render_pass_state->createInfo.ptr();
407 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
408 VkImageView image_view = framebuffer_state->createInfo.pAttachments[i];
409 SetImageViewLayout(device_data, cb_state, image_view, rpci->pAttachments[i].initialLayout);
410 }
411 // Now transition for first subpass (index 0)
412 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
413}
414
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700415void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
416 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
417 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
418 return;
419 }
420 VkImageSubresource sub = {aspect, level, layer};
421 IMAGE_CMD_BUF_LAYOUT_NODE node;
422 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700423 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700424 SetLayout(device_data, pCB, mem_barrier->image, sub,
425 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
426 return;
427 }
428 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
429 // TODO: Set memory invalid
430 }
431 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
432}
433
Dave Houlton10b39482017-03-16 13:18:15 -0600434bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600435 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600436 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600437 }
438 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600439 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600440 }
441 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600442 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600443 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700444 if (0 !=
445 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
446 if (FormatPlaneCount(format) == 1) return false;
447 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600448 return true;
449}
450
Mike Weiblen62d08a32017-03-07 22:18:27 -0700451// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
452bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
453 VkImageUsageFlags usage_flags, const char *func_name) {
454 const auto report_data = core_validation::GetReportData(device_data);
455 bool skip = false;
456 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
457 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
458
459 switch (layout) {
460 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
461 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600462 msg_code = VALIDATION_ERROR_0a000970;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700463 }
464 break;
465 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
466 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600467 msg_code = VALIDATION_ERROR_0a000972;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700468 }
469 break;
470 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
471 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600472 msg_code = VALIDATION_ERROR_0a000974;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700473 }
474 break;
475 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
476 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600477 msg_code = VALIDATION_ERROR_0a000976;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700478 }
479 break;
480 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
481 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600482 msg_code = VALIDATION_ERROR_0a000978;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700483 }
484 break;
485 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
486 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600487 msg_code = VALIDATION_ERROR_0a00097a;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700488 }
489 break;
490 default:
491 // Other VkImageLayout values do not have VUs defined in this context.
492 break;
493 }
494
495 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600496 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 -0600497 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600498 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
499 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
500 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700501 }
502 return skip;
503}
504
505// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600506bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700507 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700508 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700509
Mike Weiblen62d08a32017-03-07 22:18:27 -0700510 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
511 auto img_barrier = &pImageMemoryBarriers[i];
512 if (!img_barrier) continue;
513
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600514 auto image_state = GetImageState(device_data, img_barrier->image);
515 if (image_state) {
516 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
517 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
518 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
519
520 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
521 if (image_state->layout_locked) {
522 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600523 skip |= log_msg(
524 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600525 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, 0,
Petr Kraus13c98a62017-12-09 00:22:39 +0100526 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600527 " 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 +0100528 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600529 string_VkImageLayout(img_barrier->newLayout));
530 }
531 }
532
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600533 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600534 // For a Depth/Stencil image both aspects MUST be set
535 if (FormatIsDepthAndStencil(image_create_info->format)) {
536 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
537 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
538 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600539 skip |=
540 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
541 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), VALIDATION_ERROR_0a00096e,
542 "%s: Image barrier 0x%p references image 0x%" PRIx64
543 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
544 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
545 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600546 }
547 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600548 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
549 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700550
Mike Weiblen62d08a32017-03-07 22:18:27 -0700551 for (uint32_t j = 0; j < level_count; j++) {
552 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
553 for (uint32_t k = 0; k < layer_count; k++) {
554 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600555 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
556 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
557 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
558 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700559 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
560 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
561 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
562 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
563 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
564 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
565 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
566 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700567 }
568 }
569 }
570 return skip;
571}
572
Chris Forbes4de4b132017-08-21 11:27:08 -0700573static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600574 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700575
576 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600577 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700578}
579
Chris Forbes399a6782017-08-18 15:00:48 -0700580void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700581 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700582 for (uint32_t i = 0; i < memBarrierCount; ++i) {
583 auto mem_barrier = &pImgMemBarriers[i];
584 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700585
Chris Forbes4de4b132017-08-21 11:27:08 -0700586 // For ownership transfers, the barrier is specified twice; as a release
587 // operation on the yielding queue family, and as an acquire operation
588 // on the acquiring queue family. This barrier may also include a layout
589 // transition, which occurs 'between' the two operations. For validation
590 // purposes it doesn't seem important which side performs the layout
591 // transition, but it must not be performed twice. We'll arbitrarily
592 // choose to perform it as part of the acquire operation.
593 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
594 continue;
595 }
596
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600597 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
598 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
599 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
600
Dave Houltonb3f4b282018-02-22 16:25:16 -0700601 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
602 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
603 // for all (potential) layer sub_resources.
604 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
605 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
606 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
607 }
608
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600609 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700610 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600611 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700612 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Chris Forbes399a6782017-08-18 15:00:48 -0700613 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
614 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
615 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
616 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700617 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Chris Forbes399a6782017-08-18 15:00:48 -0700618 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
619 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
620 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700621 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700622 }
623 }
624 }
625}
626
Tobin Ehlisc8266452017-04-07 12:20:30 -0600627bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600628 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600629 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700630 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600631 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600632 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700633
634 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
635 uint32_t layer = i + subLayers.baseArrayLayer;
636 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
637 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600638 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
639 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600640 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600641 // TODO: Improve log message in the next pass
Petr Kraus13c98a62017-12-09 00:22:39 +0100642 skip |= log_msg(
643 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600644 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Petr Kraus13c98a62017-12-09 00:22:39 +0100645 "%s: Cannot use image 0x%" PRIx64 " with specific layout %s that doesn't match the actual current layout %s.",
646 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600647 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700648 }
649 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600650 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
651 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
652 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700653 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
654 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600655 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600656 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -0600657 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Petr Kraus13c98a62017-12-09 00:22:39 +0100658 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
659 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700660 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600661 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600662 if (image_state->shared_presentable) {
663 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
664 // TODO: Add unique error id when available.
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600665 skip |=
666 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 -0600667 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600668 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600669 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600670 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700671 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600672 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600673 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 -0600674 HandleToUint64(cb_node->commandBuffer), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600675 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
676 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700677 }
678 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600679 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700680}
681
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700682void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
683 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700684 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700685 if (!renderPass) return;
686
687 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
688 if (framebuffer_state) {
689 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
690 auto image_view = framebuffer_state->createInfo.pAttachments[i];
691 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
692 }
693 }
694}
Dave Houltone19e20d2018-02-02 16:32:41 -0700695
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700696bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700697 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600698 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700699 const debug_report_data *report_data = core_validation::GetReportData(device_data);
700
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600701 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600702 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 -0600703 VALIDATION_ERROR_09e0075e, "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600704
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600705 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600706 }
707
Dave Houlton130c0212018-01-29 13:39:56 -0700708 bool optimal_tiling = (VK_IMAGE_TILING_OPTIMAL == pCreateInfo->tiling);
709 const char *tiling_string = string_VkImageTiling(pCreateInfo->tiling);
710 const char *format_string = string_VkFormat(pCreateInfo->format);
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600711 VkFormatProperties properties = GetFormatProperties(device_data, pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700712 VkFormatFeatureFlags features = (optimal_tiling ? properties.optimalTilingFeatures : properties.linearTilingFeatures);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600713
Dave Houlton130c0212018-01-29 13:39:56 -0700714 if (0 == features) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600715 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700716 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ac : VALIDATION_ERROR_09e007a2);
717 ss << "vkCreateImage format parameter " << format_string << " is an unsupported format";
Mark Lobodzinski88529492018-04-01 10:38:15 -0600718 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
719 ss.str().c_str());
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600720 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600721 }
722
Dave Houlton130c0212018-01-29 13:39:56 -0700723 if ((pCreateInfo->usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600724 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700725 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ae : VALIDATION_ERROR_09e007a4);
726 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_SAMPLED_BIT is not supported for format " << format_string << " with tiling "
727 << tiling_string;
Mark Lobodzinski88529492018-04-01 10:38:15 -0600728 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
729 ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700730 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600731
Dave Houlton130c0212018-01-29 13:39:56 -0700732 if ((pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
733 std::stringstream ss;
734 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b0 : VALIDATION_ERROR_09e007a6);
735 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_STORAGE_BIT is not supported for format " << format_string << " with tiling "
736 << tiling_string;
Mark Lobodzinski88529492018-04-01 10:38:15 -0600737 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
738 ss.str().c_str());
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600739 }
740
Lenny Komowb79f04a2017-09-18 17:07:00 -0600741 // TODO: Add checks for EXTENDED_USAGE images to validate images are compatible
742 // For EXTENDED_USAGE images, format can match any image COMPATIBLE with original image
743 if (!GetDeviceExtensions(device_data)->vk_khr_maintenance2 || !(pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR)) {
744 // Validate that format supports usage as color attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700745 if ((pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
746 (0 == (features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT))) {
747 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b2 : VALIDATION_ERROR_09e007a8);
748 std::stringstream ss;
749 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_COLOR_ATTACHMENT is not supported for format " << format_string
750 << " with tiling " << tiling_string;
Mark Lobodzinski88529492018-04-01 10:38:15 -0600751 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
752 ss.str().c_str());
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600753 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600754
Lenny Komowb79f04a2017-09-18 17:07:00 -0600755 // Validate that format supports usage as depth/stencil attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700756 if ((pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
757 (0 == (features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
758 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b4 : VALIDATION_ERROR_09e007aa);
759 std::stringstream ss;
760 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT is not supported for format " << format_string
761 << " with tiling " << tiling_string;
Mark Lobodzinski88529492018-04-01 10:38:15 -0600762 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
763 ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700764 }
765 }
766
767 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
768 std::stringstream ss;
769 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 -0600770 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 -0600771 VALIDATION_ERROR_09e0076a, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700772 }
773
774 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
775 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
776 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
777 if (VK_SUCCESS != err) {
778 std::stringstream ss;
779 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
780 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600781 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 -0600782 VALIDATION_ERROR_09e00758, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700783 return skip;
784 }
785
786 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
787 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
788 std::stringstream ss;
789 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600790 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 -0600791 VALIDATION_ERROR_09e0076e, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700792 }
793
794 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
795 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
796 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
797 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600798 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700799 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
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_09e00770, "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600802 }
Dave Houlton130c0212018-01-29 13:39:56 -0700803 } else {
804 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
805 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600806 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700807 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
808 "format "
809 << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600810 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 -0600811 VALIDATION_ERROR_09e00772, "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600812 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600813 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700814 }
815
Dave Houlton130c0212018-01-29 13:39:56 -0700816 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
817 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
818 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
819 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
820 std::stringstream ss;
821 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600822 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 -0600823 VALIDATION_ERROR_09e00776, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700824 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700825 }
826
Dave Houlton130c0212018-01-29 13:39:56 -0700827 // 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 -0700828 // 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 -0700829 // implementation shown. DJH
830 //
831 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
832 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
833 // device_limits->maxImageDimension3D)) {
834 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
835 std::stringstream ss;
836 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600837 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 -0600838 VALIDATION_ERROR_09e0077e, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700839 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700840
Dave Houlton130c0212018-01-29 13:39:56 -0700841 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
842 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
843 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
844 std::stringstream ss;
845 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
846 "maxFramebufferWidth";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600847 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 -0600848 VALIDATION_ERROR_09e00788, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700849 }
850
851 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
852 std::stringstream ss;
853 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
854 "maxFramebufferHeight";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600855 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 -0600856 VALIDATION_ERROR_09e0078a, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700857 }
858
859 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
860 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
861 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
862
863 // Round up to imageGranularity boundary
864 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
865 uint64_t ig_mask = imageGranularity - 1;
866 total_size = (total_size + ig_mask) & ~ig_mask;
867
868 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600869 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 -0600870 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700871 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
872 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -0700873 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700874 }
875
Dave Houlton130c0212018-01-29 13:39:56 -0700876 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600877 skip |=
878 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 -0600879 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d.", pCreateInfo->arrayLayers,
880 format_limits.maxArrayLayers);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700881 }
882
Dave Houlton130c0212018-01-29 13:39:56 -0700883 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600884 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 -0600885 VALIDATION_ERROR_09e0078e, "CreateImage samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600886 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700887 }
888
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600889 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600890 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 -0600891 DRAWSTATE_INVALID_FEATURE,
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600892 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
893 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600894 }
895
Lenny Komowb79f04a2017-09-18 17:07:00 -0600896 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
897 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
898 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
899 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
900 // TODO: Add Maintenance2 VUID
901 skip |=
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600902 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 -0600903 VALIDATION_ERROR_UNDEFINED,
Lenny Komowb79f04a2017-09-18 17:07:00 -0600904 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
905 "format must be block, ETC or ASTC compressed, but is %s",
906 string_VkFormat(pCreateInfo->format));
907 }
908 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
909 // TODO: Add Maintenance2 VUID
910 skip |=
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600911 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 -0600912 VALIDATION_ERROR_UNDEFINED,
Lenny Komowb79f04a2017-09-18 17:07:00 -0600913 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
914 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
915 }
916 }
917 }
918
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600919 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700920}
921
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700922void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700923 IMAGE_LAYOUT_NODE image_state;
924 image_state.layout = pCreateInfo->initialLayout;
925 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700926 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 -0700927 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700928 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
929 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700930}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700931
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700932bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700933 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700934 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200935 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700936 if (disabled->destroy_image) return false;
937 bool skip = false;
938 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600939 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
940 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700941 }
942 return skip;
943}
944
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700945void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700946 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
947 // Clean up memory mapping, bindings and range references for image
948 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700949 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700950 if (mem_info) {
951 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
952 }
953 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600954 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700955 // Remove image from imageMap
956 core_validation::GetImageMap(device_data)->erase(image);
957 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
958 core_validation::GetImageSubresourceMap(device_data);
959
960 const auto &sub_entry = imageSubresourceMap->find(image);
961 if (sub_entry != imageSubresourceMap->end()) {
962 for (const auto &pair : sub_entry->second) {
963 core_validation::GetImageLayoutMap(device_data)->erase(pair);
964 }
965 imageSubresourceMap->erase(sub_entry);
966 }
967}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700968
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700969bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700970 bool skip = false;
971 const debug_report_data *report_data = core_validation::GetReportData(device_data);
972
973 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
974 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
975 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 -0600976 HandleToUint64(image_state->image), DRAWSTATE_INVALID_IMAGE_ASPECT, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700977 }
978
Dave Houlton1d2022c2017-03-29 11:43:58 -0600979 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700980 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
981 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 -0600982 HandleToUint64(image_state->image), VALIDATION_ERROR_1880000e, "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600983 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700984 char const str[] = "vkCmdClearColorImage called with compressed image.";
985 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 -0600986 HandleToUint64(image_state->image), VALIDATION_ERROR_1880000e, "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700987 }
988
989 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
990 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
991 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 -0600992 HandleToUint64(image_state->image), VALIDATION_ERROR_18800004, "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700993 }
994 return skip;
995}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700996
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600997uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
998 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
999 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001000 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001001 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001002 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001003 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001004}
1005
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001006uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1007 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1008 uint32_t array_layer_count = range->layerCount;
1009 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1010 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001011 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001012 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001013}
1014
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001015bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001016 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1017 bool skip = false;
1018 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1019
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001020 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1021 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001022
1023 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1024 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001025 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1026 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001027 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 -06001028 HandleToUint64(image_state->image), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001029 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1030 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001031 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001032 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001033 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001034 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 -06001035 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001036 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1037 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001038
1039 } else {
1040 if (image_state->shared_presentable) {
1041 skip |= log_msg(
1042 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001043 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001044 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1045 string_VkImageLayout(dest_image_layout));
1046 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001047 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001048 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001049 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001050 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001051 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001052 } else {
1053 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1054 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001055 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 -06001056 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001057 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1058 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001059 }
1060 }
1061
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001062 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1063 uint32_t level = level_index + range.baseMipLevel;
1064 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1065 uint32_t layer = layer_index + range.baseArrayLayer;
1066 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001067 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001068 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001069 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001070 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001071 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001072 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001073 } else {
1074 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1075 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001076 skip |=
1077 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1078 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1079 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001080 }
1081 }
1082 }
1083 }
1084
1085 return skip;
1086}
1087
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001088void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1089 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001090 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1091 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1092 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001093
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001094 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1095 uint32_t level = level_index + range.baseMipLevel;
1096 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1097 uint32_t layer = layer_index + range.baseArrayLayer;
1098 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001099 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001100 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1101 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 -07001102 }
1103 }
1104 }
1105}
1106
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001107bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001108 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1109 bool skip = false;
1110 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001111 auto cb_node = GetCBNode(dev_data, commandBuffer);
1112 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001113 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001114 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001115 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001116 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001117 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001118 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001119 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001120 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001121 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001122 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001123 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001124 }
1125 }
1126 return skip;
1127}
1128
1129// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001130void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001131 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001132 auto cb_node = GetCBNode(dev_data, commandBuffer);
1133 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001134 if (cb_node && image_state) {
1135 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1136 std::function<bool()> function = [=]() {
1137 SetImageMemoryValid(dev_data, image_state, true);
1138 return false;
1139 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001140 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001141 for (uint32_t i = 0; i < rangeCount; ++i) {
1142 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1143 }
1144 }
1145}
1146
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001147bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1148 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001149 const VkImageSubresourceRange *pRanges) {
1150 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001151 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1152
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001153 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001154 auto cb_node = GetCBNode(device_data, commandBuffer);
1155 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001156 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001157 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001158 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001159 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001160 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001161 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001162 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001163 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001164 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001165 skip |=
1166 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001167 // Image aspect must be depth or stencil or both
1168 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1169 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1170 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001171 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1172 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001173 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 -06001174 HandleToUint64(commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001175 }
1176 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001177 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001178 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001179 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 -06001180 HandleToUint64(image), VALIDATION_ERROR_18a0001c, "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001181 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001182 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1183 char const str[] =
1184 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1185 "set.";
1186 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 -06001187 HandleToUint64(image), VALIDATION_ERROR_18a00012, "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001188 }
1189 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1190 VkImageTiling tiling = image_state->createInfo.tiling;
1191 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1192 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1193 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001194 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 -06001195 HandleToUint64(image), VALIDATION_ERROR_18a00010,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001196 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1197 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR.",
1198 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling));
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001199 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001200 }
1201 return skip;
1202}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001203
1204// Returns true if [x, xoffset] and [y, yoffset] overlap
1205static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1206 bool result = false;
1207 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1208 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1209
1210 if (intersection_max > intersection_min) {
1211 result = true;
1212 }
1213 return result;
1214}
1215
Dave Houltonc991cc92018-03-06 11:08:51 -07001216// Returns true if source area of first copy region intersects dest area of second region
1217// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1218static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001219 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001220
Dave Houltonc991cc92018-03-06 11:08:51 -07001221 // Separate planes within a multiplane image cannot intersect
1222 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001223 return result;
1224 }
1225
Dave Houltonc991cc92018-03-06 11:08:51 -07001226 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1227 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1228 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001229 result = true;
1230 switch (type) {
1231 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001232 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001233 // Intentionally fall through to 2D case
1234 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001235 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001236 // Intentionally fall through to 1D case
1237 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001238 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001239 break;
1240 default:
1241 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1242 assert(false);
1243 }
1244 }
1245 return result;
1246}
1247
Dave Houltonfc1a4052017-04-27 14:32:45 -06001248// Returns non-zero if offset and extent exceed image extents
1249static const uint32_t x_bit = 1;
1250static const uint32_t y_bit = 2;
1251static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001252static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001253 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001254 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001255 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1256 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001257 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001258 }
1259 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1260 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001261 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001262 }
1263 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1264 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001265 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001266 }
1267 return result;
1268}
1269
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001270// Test if two VkExtent3D structs are equivalent
1271static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1272 bool result = true;
1273 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1274 (extent->depth != other_extent->depth)) {
1275 result = false;
1276 }
1277 return result;
1278}
1279
Dave Houltonee281a52017-12-08 13:51:02 -07001280// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1281// Destination image texel extents must be adjusted by block size for the dest validation checks
1282VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1283 VkExtent3D adjusted_extent = extent;
1284 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1285 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1286 adjusted_extent.width /= block_size.width;
1287 adjusted_extent.height /= block_size.height;
1288 adjusted_extent.depth /= block_size.depth;
1289 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1290 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1291 adjusted_extent.width *= block_size.width;
1292 adjusted_extent.height *= block_size.height;
1293 adjusted_extent.depth *= block_size.depth;
1294 }
1295 return adjusted_extent;
1296}
1297
Dave Houlton6f9059e2017-05-02 17:15:13 -06001298// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001299static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1300 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001301
1302 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001303 if (mip >= img->createInfo.mipLevels) {
1304 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001305 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001306
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001307 // 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 -06001308 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001309 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1310 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1311 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001312
Dave Houlton6f9059e2017-05-02 17:15:13 -06001313 // Image arrays have an effective z extent that isn't diminished by mip level
1314 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001315 extent.depth = img->createInfo.arrayLayers;
1316 }
1317
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001318 return extent;
1319}
1320
1321// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001322static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001323 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1324}
1325
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001326// Test if the extent argument has any dimensions set to 0.
1327static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1328 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1329}
1330
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001331// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1332static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1333 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1334 VkExtent3D granularity = {0, 0, 0};
1335 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1336 if (pPool) {
1337 granularity =
1338 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001339 if (FormatIsCompressed(img->createInfo.format)) {
1340 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001341 granularity.width *= block_size.width;
1342 granularity.height *= block_size.height;
1343 }
1344 }
1345 return granularity;
1346}
1347
1348// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1349static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1350 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001351 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1352 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001353 valid = false;
1354 }
1355 return valid;
1356}
1357
1358// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1359static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1360 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1361 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1362 bool skip = false;
1363 VkExtent3D offset_extent = {};
1364 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1365 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1366 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001367 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001368 // 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 -07001369 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001370 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 -06001371 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001372 "%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 "
1373 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001374 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001375 }
1376 } else {
1377 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1378 // integer multiples of the image transfer granularity.
1379 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001380 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 -06001381 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001382 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1383 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001384 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1385 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001386 }
1387 }
1388 return skip;
1389}
1390
1391// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1392static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1393 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001394 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001395 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1396 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001397 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001398 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1399 // subresource extent.
1400 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001401 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 -06001402 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Petr Krausbc7f5442017-05-14 23:43:38 +02001403 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1404 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1405 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1406 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001407 }
1408 } else {
1409 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1410 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1411 // subresource extent dimensions.
1412 VkExtent3D offset_extent_sum = {};
1413 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1414 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1415 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001416 bool x_ok = true;
1417 bool y_ok = true;
1418 bool z_ok = true;
1419 switch (image_type) {
1420 case VK_IMAGE_TYPE_3D:
1421 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1422 (subresource_extent->depth == offset_extent_sum.depth));
1423 // Intentionally fall through to 2D case
1424 case VK_IMAGE_TYPE_2D:
1425 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1426 (subresource_extent->height == offset_extent_sum.height));
1427 // Intentionally fall through to 1D case
1428 case VK_IMAGE_TYPE_1D:
1429 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1430 (subresource_extent->width == offset_extent_sum.width));
1431 break;
1432 default:
1433 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1434 assert(false);
1435 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001436 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001437 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 -06001438 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001439 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1440 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1441 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1442 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1443 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1444 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001445 }
1446 }
1447 return skip;
1448}
1449
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001450// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001451bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1452 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1453 const uint32_t i, const char *function) {
1454 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001455 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001456 // TODO: Add granularity checking for compressed formats
1457
1458 // bufferRowLength must be a multiple of the compressed texel block width
1459 // bufferImageHeight must be a multiple of the compressed texel block height
1460 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1461 // bufferOffset must be a multiple of the compressed texel block size in bytes
1462 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1463 // must equal the image subresource width
1464 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1465 // must equal the image subresource height
1466 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1467 // must equal the image subresource depth
1468 } else {
1469 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001470 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1471 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1472 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001473 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001474 }
1475 return skip;
1476}
1477
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001478// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001479bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001480 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1481 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001482 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001483 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001484 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001485 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001486 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001487 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001488 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001489 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001490
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001491 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001492 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001493 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houltonee281a52017-12-08 13:51:02 -07001494 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001495 const VkExtent3D dest_effective_extent =
1496 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001497 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001498 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001499 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001500 return skip;
1501}
1502
Dave Houlton6f9059e2017-05-02 17:15:13 -06001503// Validate contents of a VkImageCopy struct
1504bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1505 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1506 bool skip = false;
1507
1508 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001509 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001510
1511 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001512 const VkExtent3D src_copy_extent = region.extent;
1513 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001514 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1515
Dave Houlton6f9059e2017-05-02 17:15:13 -06001516 bool slice_override = false;
1517 uint32_t depth_slices = 0;
1518
1519 // Special case for copying between a 1D/2D array and a 3D image
1520 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1521 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001522 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001523 slice_override = (depth_slices != 1);
1524 } 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 -07001525 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001526 slice_override = (depth_slices != 1);
1527 }
1528
1529 // Do all checks on source image
1530 //
1531 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001532 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1533 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 -06001534 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00124,
Dave Houltonee281a52017-12-08 13:51:02 -07001535 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001536 "be 0 and 1, respectively.",
1537 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001538 }
1539 }
1540
Dave Houlton533be9f2018-03-26 17:08:30 -06001541 // VUID-VkImageCopy-srcImage-01785
1542 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1543 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 -06001544 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00df2,
Dave Houlton533be9f2018-03-26 17:08:30 -06001545 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001546 "these must be 0 and 1, respectively.",
1547 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001548 }
1549
Dave Houlton533be9f2018-03-26 17:08:30 -06001550 // VUID-VkImageCopy-srcImage-01787
1551 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1552 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 -06001553 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00df6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001554 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
1555 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06001556 }
1557
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001558 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001559 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001560 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001561 skip |=
1562 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001563 HandleToUint64(src_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001564 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001565 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1566 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001567 }
1568 }
1569 } else { // Pre maint 1
1570 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001571 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001572 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 -06001573 HandleToUint64(src_state->image), VALIDATION_ERROR_09c0011a,
Petr Kraus13c98a62017-12-09 00:22:39 +01001574 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1575 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001576 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1577 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001578 }
1579 }
1580 }
1581
Dave Houltonc991cc92018-03-06 11:08:51 -07001582 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1583 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
1584 if (FormatIsCompressed(src_state->createInfo.format) ||
1585 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001586 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001587 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001588 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1589 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1590 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001591 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d7e : VALIDATION_ERROR_09c0013a;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001592 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 -07001593 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001594 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001595 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001596 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001597 }
1598
Dave Houlton94a00372017-12-14 15:08:47 -07001599 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001600 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1601 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001602 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d80 : VALIDATION_ERROR_09c0013c;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001603 skip |=
1604 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001605 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001606 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001607 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001608 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001609 }
1610
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001611 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001612 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1613 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001614 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d82 : VALIDATION_ERROR_09c0013e;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001615 skip |=
1616 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001617 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001618 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001619 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001620 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001621 }
1622
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001623 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001624 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1625 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001626 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d84 : VALIDATION_ERROR_09c00140;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001627 skip |=
1628 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001629 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001630 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001631 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001632 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001633 }
1634 } // Compressed
1635
1636 // Do all checks on dest image
1637 //
1638 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001639 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001640 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 -06001641 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00130,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001642 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001643 "these must be 0 and 1, respectively.",
1644 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001645 }
1646 }
1647
Dave Houlton533be9f2018-03-26 17:08:30 -06001648 // VUID-VkImageCopy-dstImage-01786
1649 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
1650 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 -06001651 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00df4,
Dave Houlton533be9f2018-03-26 17:08:30 -06001652 "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 -06001653 "and 1, respectively.",
1654 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06001655 }
1656
1657 // VUID-VkImageCopy-dstImage-01788
1658 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
1659 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 -06001660 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00df8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001661 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
1662 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001663 }
1664
1665 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001666 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001667 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 -06001668 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001669 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001670 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1671 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001672 }
1673 }
1674 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001675 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001676 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001677 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001678 skip |=
1679 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001680 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001681 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001682 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1683 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001684 }
1685 }
1686 } else { // Pre maint 1
1687 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001688 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001689 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 -06001690 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Petr Kraus13c98a62017-12-09 00:22:39 +01001691 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1692 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001693 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1694 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001695 }
1696 }
1697 }
1698
Dave Houltonc991cc92018-03-06 11:08:51 -07001699 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1700 if (FormatIsCompressed(dst_state->createInfo.format) ||
1701 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001702 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001703
1704 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001705 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1706 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1707 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001708 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d86 : VALIDATION_ERROR_09c00144;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001709 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 -07001710 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001711 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001712 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001713 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001714 }
1715
Dave Houlton94a00372017-12-14 15:08:47 -07001716 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001717 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1718 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001719 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d88 : VALIDATION_ERROR_09c00146;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001720 skip |=
1721 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001722 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001723 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001724 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001725 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001726 }
1727
Dave Houltonee281a52017-12-08 13:51:02 -07001728 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1729 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1730 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001731 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d8a : VALIDATION_ERROR_09c00148;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001732 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 -07001733 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001734 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1735 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07001736 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001737 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001738 }
1739
Dave Houltonee281a52017-12-08 13:51:02 -07001740 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1741 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1742 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001743 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d8c : VALIDATION_ERROR_09c0014a;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001744 skip |=
1745 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001746 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001747 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001748 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001749 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001750 }
1751 } // Compressed
1752 }
1753 return skip;
1754}
1755
Dave Houltonc991cc92018-03-06 11:08:51 -07001756// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
1757bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
1758 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
1759 bool skip = false;
1760 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
1761
1762 // Neither image is multiplane
1763 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
1764 // If neither image is multi-plane the aspectMask member of src and dst must match
1765 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1766 std::stringstream ss;
1767 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
1768 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
1769 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1770 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c1e, "%s.", ss.str().c_str());
1771 }
1772 } else {
1773 // Source image multiplane checks
1774 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
1775 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
1776 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
1777 std::stringstream ss;
1778 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
1779 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1780 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c20, "%s.", ss.str().c_str());
1781 }
1782 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
1783 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
1784 std::stringstream ss;
1785 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
1786 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1787 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c22, "%s.", ss.str().c_str());
1788 }
1789 // Single-plane to multi-plane
1790 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
1791 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
1792 std::stringstream ss;
1793 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
1794 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1795 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c2a, "%s.", ss.str().c_str());
1796 }
1797
1798 // Dest image multiplane checks
1799 planes = FormatPlaneCount(dst_image_state->createInfo.format);
1800 aspect = region.dstSubresource.aspectMask;
1801 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
1802 std::stringstream ss;
1803 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
1804 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1805 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c24, "%s.", ss.str().c_str());
1806 }
1807 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
1808 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
1809 std::stringstream ss;
1810 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
1811 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1812 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c26, "%s.", ss.str().c_str());
1813 }
1814 // Multi-plane to single-plane
1815 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
1816 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
1817 std::stringstream ss;
1818 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
1819 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1820 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c28, "%s.", ss.str().c_str());
1821 }
1822 }
1823
1824 return skip;
1825}
1826
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001827bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001828 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1829 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001830 bool skip = false;
1831 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001832 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1833
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001834 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1835
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001836 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001837 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001838
1839 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1840 VkExtent3D src_copy_extent = region.extent;
1841 VkExtent3D dst_copy_extent =
1842 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1843
Dave Houlton6f9059e2017-05-02 17:15:13 -06001844 bool slice_override = false;
1845 uint32_t depth_slices = 0;
1846
1847 // Special case for copying between a 1D/2D array and a 3D image
1848 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1849 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1850 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001851 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001852 slice_override = (depth_slices != 1);
1853 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1854 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001855 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001856 slice_override = (depth_slices != 1);
1857 }
1858
Dave Houltonee281a52017-12-08 13:51:02 -07001859 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001860 std::stringstream ss;
1861 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001862 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 -06001863 HandleToUint64(command_buffer), DRAWSTATE_INVALID_IMAGE_ASPECT, "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001864 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001865
Dave Houltonee281a52017-12-08 13:51:02 -07001866 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001867 std::stringstream ss;
1868 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001869 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 -06001870 HandleToUint64(command_buffer), DRAWSTATE_INVALID_IMAGE_ASPECT, "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001871 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001872
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001873 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001874 // No chance of mismatch if we're overriding depth slice count
1875 if (!slice_override) {
1876 // The number of depth slices in srcSubresource and dstSubresource must match
1877 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1878 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001879 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1880 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001881 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001882 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1883 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001884 if (src_slices != dst_slices) {
1885 std::stringstream ss;
1886 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1887 << "] do not match";
1888 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 -06001889 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00118, "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06001890 }
1891 }
1892 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001893 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001894 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001895 std::stringstream ss;
1896 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1897 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001898 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 -06001899 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00118, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001900 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001901 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001902
Dave Houltonc991cc92018-03-06 11:08:51 -07001903 // Do multiplane-specific checks, if extension enabled
1904 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1905 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
1906 }
1907
Dave Houltonf5217612018-02-02 16:18:52 -07001908 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1909 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
1910 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1911 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1912 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 -06001913 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00112, "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07001914 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001915 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001916
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001917 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001918 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001919 std::stringstream ss;
1920 ss << "vkCmdCopyImage: pRegion[" << i
1921 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1922 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 -06001923 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0011c, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001924 }
1925
1926 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001927 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001928 std::stringstream ss;
1929 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1930 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 -06001931 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0011e, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001932 }
1933
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001934 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001935 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1936 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001937 std::stringstream ss;
1938 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1939 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 -06001940 HandleToUint64(command_buffer), VALIDATION_ERROR_0a600150, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001941 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001942
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001943 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1944 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001945 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1946 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001947 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1948 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 -06001949 HandleToUint64(command_buffer), VALIDATION_ERROR_0a60014e, "%s.", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001950 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001951
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001952 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001953 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001954 std::stringstream ss;
1955 ss << "vkCmdCopyImage: pRegions[" << i
1956 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1957 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 -06001958 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d40, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001959 }
Dave Houltonee281a52017-12-08 13:51:02 -07001960 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001961 std::stringstream ss;
1962 ss << "vkCmdCopyImage: pRegions[" << i
1963 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1964 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 -06001965 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d42, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001966 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001967
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001968 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1969 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001970 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001971 std::stringstream ss;
1972 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001973 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001974 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 -06001975 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d44, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001976 }
Dave Houltonee281a52017-12-08 13:51:02 -07001977 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001978 std::stringstream ss;
1979 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001980 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001981 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 -06001982 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d46, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001983 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001984
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001985 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1986 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1987 // 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 -07001988 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1989 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001990 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001991 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1992 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1993 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1994 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001995 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 -06001996 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f4, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001997 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001998
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001999 // 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 -07002000 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2001 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002002 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002003 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2004 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2005 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2006 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002007 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 -06002008 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f6, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002009 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002010 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002011
Dave Houltonfc1a4052017-04-27 14:32:45 -06002012 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002013 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2014 if (slice_override) src_copy_extent.depth = depth_slices;
2015 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002016 if (extent_check & x_bit) {
2017 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 -06002018 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00120,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002019 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002020 "width [%1d].",
2021 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002022 }
2023
2024 if (extent_check & y_bit) {
2025 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 -06002026 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00122,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002027 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002028 "height [%1d].",
2029 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002030 }
2031 if (extent_check & z_bit) {
2032 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), VALIDATION_ERROR_09c00126,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002034 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002035 "depth [%1d].",
2036 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002037 }
2038
Dave Houltonee281a52017-12-08 13:51:02 -07002039 // Adjust dest extent if necessary
2040 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2041 if (slice_override) dst_copy_extent.depth = depth_slices;
2042
2043 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002044 if (extent_check & x_bit) {
2045 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 -06002046 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0012c,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002047 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002048 "width [%1d].",
2049 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002050 }
2051 if (extent_check & y_bit) {
2052 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 -06002053 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0012e,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002054 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002055 "height [%1d].",
2056 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002057 }
2058 if (extent_check & z_bit) {
2059 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 -06002060 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00132,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002061 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002062 "depth [%1d].",
2063 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002064 }
2065
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002066 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2067 // must not overlap in memory
2068 if (src_image_state->image == dst_image_state->image) {
2069 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002070 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2071 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002072 std::stringstream ss;
2073 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2074 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 -06002075 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f8, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002076 }
2077 }
2078 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002079 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002080
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002081 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2082 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2083 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002084 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002085 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2086 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002087 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 -06002088 HandleToUint64(command_buffer), DRAWSTATE_MISMATCHED_IMAGE_FORMAT, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002089 }
2090 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002091 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2092 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002093 if (srcSize != destSize) {
2094 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2095 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 -06002096 HandleToUint64(command_buffer), VALIDATION_ERROR_1900010e, "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002097 }
2098 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002099
Dave Houlton33c22b72017-02-28 13:16:02 -07002100 // Source and dest image sample counts must match
2101 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2102 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2103 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 -06002104 HandleToUint64(command_buffer), VALIDATION_ERROR_19000110, "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002105 }
2106
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002107 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2108 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002109 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002110 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002111 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002112 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002113 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002114 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002115 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002116 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002117 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002118 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002119 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002120 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002121 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002122 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002123 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002124 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2125 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002126 }
2127
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002128 return skip;
2129}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002130
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002131void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002132 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2133 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2134 // Make sure that all image slices are updated to correct layout
2135 for (uint32_t i = 0; i < region_count; ++i) {
2136 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2137 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2138 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002139 // Update bindings between images and cmd buffer
2140 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2141 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002142 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002143 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002144 function = [=]() {
2145 SetImageMemoryValid(device_data, dst_image_state, true);
2146 return false;
2147 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002148 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002149}
2150
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002151// Returns true if sub_rect is entirely contained within rect
2152static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2153 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2154 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2155 return false;
2156 return true;
2157}
2158
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002159bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2160 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002161 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002162 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2163
2164 bool skip = false;
2165 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002166 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2167 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002168 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002169 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002170 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002171 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2172 // 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 -07002173 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2174 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002175 skip |= log_msg(
2176 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002177 HandleToUint64(commandBuffer), DRAWSTATE_CLEAR_CMD_BEFORE_DRAW,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002178 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2179 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2180 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002181 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002182 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002183 }
2184
2185 // Validate that attachment is in reference list of active subpass
2186 if (cb_node->activeRenderPass) {
2187 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2188 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002189 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002190
2191 for (uint32_t i = 0; i < attachmentCount; i++) {
2192 auto clear_desc = &pAttachments[i];
2193 VkImageView image_view = VK_NULL_HANDLE;
2194
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002195 if (0 == clear_desc->aspectMask) {
2196 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 -06002197 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00c03, " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002198 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2199 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 -06002200 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00028, " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002201 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002202 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002203 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 -06002204 HandleToUint64(commandBuffer), VALIDATION_ERROR_1860001e,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002205 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d.",
2206 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002207 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2208 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002209 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -06002210 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002211 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2212 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002213 } else {
2214 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002215 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002216 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002217 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2218 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2219 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002220 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002221 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 -06002222 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00026, str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002223 }
2224 } else { // Must be depth and/or stencil
2225 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2226 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002227 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002228 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 -06002229 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00c01, str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002230 }
2231 if (!subpass_desc->pDepthStencilAttachment ||
2232 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2233 skip |= log_msg(
2234 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002235 HandleToUint64(commandBuffer), DRAWSTATE_MISSING_ATTACHMENT_REFERENCE,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002236 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002237 } else {
2238 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2239 }
2240 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002241 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002242 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002243 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002244 // The rectangular region specified by a given element of pRects must be contained within the render area of
2245 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002246 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2247 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2248 skip |=
2249 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 -06002250 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600020,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002251 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002252 "the current render pass instance.",
2253 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002254 }
2255 } else {
2256 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2257 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2258 return log_msg(
2259 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002260 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600020,
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002261 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002262 "the current render pass instance.",
2263 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002264 }
2265 return false;
2266 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002267 }
2268 // The layers specified by a given element of pRects must be contained within every attachment that
2269 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002270 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002271 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2272 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002273 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 -06002274 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600022,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002275 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002276 "of pAttachment[%d].",
2277 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002278 }
2279 }
2280 }
2281 }
2282 }
2283 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002284}
2285
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002286bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002287 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002288 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002289 bool skip = false;
2290 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002291 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2292 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2293 skip |=
2294 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002295 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002296 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002297
2298 // For each region, the number of layers in the image subresource should not be zero
2299 // For each region, src and dest image aspect must be color only
2300 for (uint32_t i = 0; i < regionCount; i++) {
2301 if (pRegions[i].srcSubresource.layerCount == 0) {
2302 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002303 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 -06002304 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002305 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002306 if (pRegions[i].dstSubresource.layerCount == 0) {
2307 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002308 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 -06002309 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002310 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002311 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2312 skip |= log_msg(
2313 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002314 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_0a200216,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002315 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002316 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002317 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2318 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2319 char const str[] =
2320 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2321 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 -06002322 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_0a200214, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002323 }
2324 }
2325
2326 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2327 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002328 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 -06002329 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_FORMAT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002330 }
2331 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2332 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002333 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 -06002334 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_TYPE, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002335 }
2336 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2337 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2338 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 -06002339 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_1c800202, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002340 }
2341 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2342 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2343 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 -06002344 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_1c800206, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002345 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002346 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002347 } else {
2348 assert(0);
2349 }
2350 return skip;
2351}
2352
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002353void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2354 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002355 // Update bindings between images and cmd buffer
2356 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2357 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2358
2359 std::function<bool()> function = [=]() {
2360 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2361 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002362 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002363 function = [=]() {
2364 SetImageMemoryValid(device_data, dst_image_state, true);
2365 return false;
2366 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002367 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002368}
2369
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002370bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002371 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2372 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002373 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2374
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002375 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002376 if (cb_node) {
2377 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2378 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002379 if (cb_node && src_image_state && dst_image_state) {
2380 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002381 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002382 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002383 VALIDATION_ERROR_184001d4);
2384 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2385 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2386 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2387 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2388 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2389 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2390 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002391 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002392 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002393 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002394
Dave Houlton33c2d252017-06-09 17:08:32 -06002395 VkFormat src_format = src_image_state->createInfo.format;
2396 VkFormat dst_format = dst_image_state->createInfo.format;
2397 VkImageType src_type = src_image_state->createInfo.imageType;
2398 VkImageType dst_type = dst_image_state->createInfo.imageType;
2399
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002400 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002401 VkImageTiling tiling = src_image_state->createInfo.tiling;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002402 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002403 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2404 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 -06002405 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b4,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002406 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature.",
2407 string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002408 }
2409
2410 if ((VK_FILTER_LINEAR == filter) &&
2411 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002412 skip |=
2413 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 -06002414 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002415 "vkCmdBlitImage: source image format %s does not support linear filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002416 }
2417
2418 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2419 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002420 skip |=
2421 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 -06002422 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002423 "vkCmdBlitImage: source image format %s does not support cubic filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002424 }
2425
2426 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2427 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 -06002428 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001da,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002429 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002430 }
2431
2432 props = GetFormatProperties(device_data, dst_format);
2433 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002434 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002435 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002436 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 -06002437 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001be,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002438 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature.",
2439 string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002440 }
2441
2442 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2443 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
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), VALIDATION_ERROR_184001c8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002446 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002447 }
2448
2449 // Validate consistency for unsigned formats
2450 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2451 std::stringstream ss;
2452 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2453 << "the other one must also have unsigned integer format. "
2454 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2455 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 -06002456 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001cc, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002457 }
2458
2459 // Validate consistency for signed formats
2460 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2461 std::stringstream ss;
2462 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2463 << "the other one must also have signed integer format. "
2464 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2465 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 -06002466 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ca, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002467 }
2468
2469 // Validate filter for Depth/Stencil formats
2470 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2471 std::stringstream ss;
2472 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2473 << "then filter must be VK_FILTER_NEAREST.";
2474 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 -06002475 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d0, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002476 }
2477
2478 // Validate aspect bits and formats for depth/stencil images
2479 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2480 if (src_format != dst_format) {
2481 std::stringstream ss;
2482 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2483 << "stencil, the other one must have exactly the same format. "
2484 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2485 << string_VkFormat(dst_format);
Mark Lobodzinski88529492018-04-01 10:38:15 -06002486 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2487 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ce, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002488 }
2489
2490#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2491 for (uint32_t i = 0; i < regionCount; i++) {
2492 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2493
2494 if (FormatIsDepthAndStencil(src_format)) {
2495 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2496 std::stringstream ss;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002497 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of VK_IMAGE_ASPECT_DEPTH_BIT "
Dave Houlton33c2d252017-06-09 17:08:32 -06002498 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2499 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 -06002500 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002501 "%s", ss.str().c_str());
2502 }
2503 }
2504 else if (FormatIsStencilOnly(src_format)) {
2505 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2506 std::stringstream ss;
2507 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2508 << "set in both the srcImage and dstImage";
2509 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 -06002510 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002511 "%s", ss.str().c_str());
2512 }
2513 }
2514 else if (FormatIsDepthOnly(src_format)) {
2515 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2516 std::stringstream ss;
2517 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2518 << "set in both the srcImage and dstImage";
2519 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), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002521 "%s", ss.str().c_str());
2522 }
2523 }
2524 }
2525#endif
2526 } // Depth or Stencil
2527
2528 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002529 for (uint32_t i = 0; i < region_count; i++) {
2530 const VkImageBlit rgn = regions[i];
2531 bool hit_error = false;
2532 skip |=
2533 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2534 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2535 skip |=
2536 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2537 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002538
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002539 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002540 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2541 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002542 std::stringstream ss;
2543 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2544 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 -06002545 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_EXTENTS, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002546 }
Dave Houlton48989f32017-05-26 15:01:46 -06002547 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2548 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002549 std::stringstream ss;
2550 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2551 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 -06002552 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_EXTENTS, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002553 }
Dave Houlton48989f32017-05-26 15:01:46 -06002554 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002555 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2556 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 -06002557 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002558 }
Dave Houlton48989f32017-05-26 15:01:46 -06002559 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002560 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2561 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 -06002562 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002563 }
2564
2565 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002566 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002567 skip |=
2568 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 -06002569 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001de,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002570 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002571 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002572
Dave Houlton48989f32017-05-26 15:01:46 -06002573 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002574 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 -06002575 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001dc,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002576 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002577 }
Dave Houlton48989f32017-05-26 15:01:46 -06002578
Dave Houlton33c2d252017-06-09 17:08:32 -06002579 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2580 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 -06002581 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e2,
Dave Houlton33c2d252017-06-09 17:08:32 -06002582 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002583 "image format %s.",
2584 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002585 }
2586
2587 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2588 skip |= log_msg(
2589 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002590 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e4,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002591 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
2592 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002593 }
2594
Dave Houlton48989f32017-05-26 15:01:46 -06002595 // Validate source image offsets
2596 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002597 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002598 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2599 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 -06002600 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ea,
Dave Houlton48989f32017-05-26 15:01:46 -06002601 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002602 "of (%1d, %1d). These must be (0, 1).",
2603 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002604 }
2605 }
2606
Dave Houlton33c2d252017-06-09 17:08:32 -06002607 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002608 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2609 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 -06002610 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ee,
Dave Houlton48989f32017-05-26 15:01:46 -06002611 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002612 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
2613 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002614 }
2615 }
2616
Dave Houlton33c2d252017-06-09 17:08:32 -06002617 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002618 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2619 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002620 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002621 skip |=
2622 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 -06002623 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002624 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
2625 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002626 }
2627 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2628 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002629 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002630 skip |= log_msg(
2631 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002632 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002633 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
2634 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002635 }
2636 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2637 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002638 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002639 skip |=
2640 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 -06002641 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ec,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002642 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
2643 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002644 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002645 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2646 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 -06002647 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ae,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002648 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d.", i,
2649 rgn.srcSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002650 } else if (oob) {
2651 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 -06002652 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ae,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002653 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06002654 }
Dave Houlton48989f32017-05-26 15:01:46 -06002655
2656 // Validate dest image offsets
2657 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002658 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002659 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2660 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 -06002661 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f4,
Dave Houlton48989f32017-05-26 15:01:46 -06002662 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002663 "(%1d, %1d). These must be (0, 1).",
2664 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002665 }
2666 }
2667
Dave Houlton33c2d252017-06-09 17:08:32 -06002668 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002669 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2670 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 -06002671 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f8,
Dave Houlton48989f32017-05-26 15:01:46 -06002672 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002673 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
2674 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002675 }
2676 }
2677
Dave Houlton33c2d252017-06-09 17:08:32 -06002678 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002679 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2680 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002681 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002682 skip |=
2683 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 -06002684 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002685 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
2686 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002687 }
2688 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2689 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002690 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002691 skip |= log_msg(
2692 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002693 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f2,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002694 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
2695 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002696 }
2697 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2698 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002699 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002700 skip |=
2701 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 -06002702 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002703 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
2704 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002705 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002706 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002707 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 -06002708 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002709 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d.", i,
2710 rgn.dstSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002711 } else if (oob) {
2712 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 -06002713 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002714 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002715 }
2716
Dave Houlton33c2d252017-06-09 17:08:32 -06002717 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2718 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2719 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2720 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 -06002721 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e0,
Dave Houlton33c2d252017-06-09 17:08:32 -06002722 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002723 "layerCount other than 1.",
2724 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002725 }
2726 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002727 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002728 } else {
2729 assert(0);
2730 }
2731 return skip;
2732}
2733
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002734void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002735 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2736 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2737 // Make sure that all image slices are updated to correct layout
2738 for (uint32_t i = 0; i < region_count; ++i) {
2739 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2740 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2741 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002742 // Update bindings between images and cmd buffer
2743 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2744 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2745
2746 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002747 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002748 function = [=]() {
2749 SetImageMemoryValid(device_data, dst_image_state, true);
2750 return false;
2751 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002752 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002753}
2754
Tony Barbourdf013b92017-01-25 12:53:48 -07002755// This validates that the initial layout specified in the command buffer for
2756// the IMAGE is the same
2757// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002758bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002759 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2760 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002761 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002762 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002763 for (auto cb_image_data : pCB->imageLayoutMap) {
2764 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002765
Dave Houltonb3f4b282018-02-22 16:25:16 -07002766 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2767 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002768 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2769 // TODO: Set memory invalid which is in mem_tracker currently
2770 } else if (imageLayout != cb_image_data.second.initialLayout) {
2771 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002772 skip |= log_msg(
2773 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002774 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002775 "Cannot submit cmd buffer using image (0x%" PRIx64
2776 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2777 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2778 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2779 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002780 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002781 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 -06002782 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002783 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002784 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2785 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002786 }
2787 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002788 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002789 }
2790 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002791 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002792}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002793
Tony Barbourdf013b92017-01-25 12:53:48 -07002794void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2795 for (auto cb_image_data : pCB->imageLayoutMap) {
2796 VkImageLayout imageLayout;
2797 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2798 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2799 }
2800}
2801
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002802// Print readable FlagBits in FlagMask
2803static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2804 std::string result;
2805 std::string separator;
2806
2807 if (accessMask == 0) {
2808 result = "[None]";
2809 } else {
2810 result = "[";
2811 for (auto i = 0; i < 32; i++) {
2812 if (accessMask & (1 << i)) {
2813 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2814 separator = " | ";
2815 }
2816 }
2817 result = result + "]";
2818 }
2819 return result;
2820}
2821
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002822// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2823// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002824// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002825static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2826 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2827 const char *type) {
2828 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2829 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002830
2831 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2832 if (accessMask & ~(required_bit | optional_bits)) {
2833 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002834 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 -06002835 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002836 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2837 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002838 }
2839 } else {
2840 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002841 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 -06002842 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002843 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
2844 "has previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002845 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2846 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002847 } else {
2848 std::string opt_bits;
2849 if (optional_bits != 0) {
2850 std::stringstream ss;
2851 ss << optional_bits;
2852 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2853 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002854 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 -06002855 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002856 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
2857 "previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002858 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2859 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002860 }
2861 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002862 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002863}
2864
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002865// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002866// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2867// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002868bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002869 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2870 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002871 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2872 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2873 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2874 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002875 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 -06002876 VALIDATION_ERROR_12200688, "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002877 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002878 }
2879 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002880 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002881}
2882
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002883bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2884 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002885 bool skip = false;
2886
Jason Ekstranda1906302017-12-03 20:16:32 -08002887 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2888 VkFormat format = pCreateInfo->pAttachments[i].format;
2889 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2890 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2891 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002892 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 -06002893 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002894 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
2895 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2896 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2897 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002898 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07002899 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002900 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 -06002901 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002902 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
2903 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2904 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2905 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002906 }
2907 }
2908 }
2909
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002910 // Track when we're observing the first use of an attachment
2911 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2912 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2913 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002914
2915 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2916 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2917 auto attach_index = subpass.pInputAttachments[j].attachment;
2918 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2919
2920 switch (subpass.pInputAttachments[j].layout) {
2921 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2922 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2923 // These are ideal.
2924 break;
2925
2926 case VK_IMAGE_LAYOUT_GENERAL:
2927 // May not be optimal. TODO: reconsider this warning based on other constraints.
2928 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002929 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Cort Stratton7547f772017-05-04 15:18:52 -07002930 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2931 break;
2932
2933 default:
2934 // No other layouts are acceptable
2935 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 -06002936 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Cort Stratton7547f772017-05-04 15:18:52 -07002937 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2938 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2939 }
2940
2941 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2942 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2943 subpass.pDepthStencilAttachment->attachment == attach_index &&
2944 subpass.pDepthStencilAttachment->layout != layout;
2945 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2946 found_layout_mismatch =
2947 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2948 }
2949 if (found_layout_mismatch) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002950 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 -06002951 VALIDATION_ERROR_140006ae,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002952 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002953 "depth/color attachment with a different layout.",
2954 i, j, attach_index, layout);
Cort Stratton7547f772017-05-04 15:18:52 -07002955 }
2956
2957 if (attach_first_use[attach_index]) {
2958 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2959 pCreateInfo->pAttachments[attach_index]);
2960
2961 bool used_as_depth =
2962 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2963 bool used_as_color = false;
2964 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2965 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2966 }
2967 if (!used_as_depth && !used_as_color &&
2968 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2969 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002970 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002971 VALIDATION_ERROR_1400069c,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002972 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
2973 attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07002974 }
2975 }
2976 attach_first_use[attach_index] = false;
2977 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002978 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2979 auto attach_index = subpass.pColorAttachments[j].attachment;
2980 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2981
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002982 // TODO: Need a way to validate shared presentable images here, currently just allowing
2983 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2984 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002985 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002986 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002987 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002988 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2989 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002990 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002991
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002992 case VK_IMAGE_LAYOUT_GENERAL:
2993 // May not be optimal; TODO: reconsider this warning based on other constraints?
2994 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002995 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002996 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2997 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002998
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002999 default:
3000 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 -06003001 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003002 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3003 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003004 }
3005
3006 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003007 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
3008 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003009 }
3010 attach_first_use[attach_index] = false;
3011 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003012
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003013 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3014 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003015 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3016 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3017 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003018 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003019
Dave Houltona9df0ce2018-02-07 10:51:23 -07003020 case VK_IMAGE_LAYOUT_GENERAL:
3021 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3022 // doing a bunch of transitions.
3023 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003024 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003025 "GENERAL layout for depth attachment may not give optimal performance.");
3026 break;
3027
3028 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3029 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3030 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3031 break;
3032 } else {
3033 // Intentionally fall through to generic error message
3034 }
3035
3036 default:
3037 // No other layouts are acceptable
3038 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 -06003039 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003040 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3041 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3042 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003043 }
3044
3045 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3046 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003047 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
3048 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003049 }
3050 attach_first_use[attach_index] = false;
3051 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003052 }
3053 return skip;
3054}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003055
3056// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003057bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3058 VkDeviceSize offset, VkDeviceSize end_offset) {
3059 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3060 bool skip = false;
3061 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3062 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003063 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3064 for (auto image_handle : mem_info->bound_images) {
3065 auto img_it = mem_info->bound_ranges.find(image_handle);
3066 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003067 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003068 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003069 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003070 for (auto layout : layouts) {
3071 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003072 skip |=
3073 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 -06003074 HandleToUint64(mem_info->mem), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003075 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3076 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003077 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003078 }
3079 }
3080 }
3081 }
3082 }
3083 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003084 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003085}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003086
3087// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3088// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003089static 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 -06003090 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003091 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003092
3093 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003094 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003095 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003096 if (strict) {
3097 correct_usage = ((actual & desired) == desired);
3098 } else {
3099 correct_usage = ((actual & desired) != 0);
3100 }
3101 if (!correct_usage) {
3102 if (msgCode == -1) {
3103 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003104 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003105 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 -06003106 MEMTRACK_INVALID_USAGE_FLAG,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003107 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3108 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003109 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003110 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003111 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 -06003112 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3113 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003114 }
3115 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003116 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003117}
3118
3119// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3120// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003121bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003122 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003123 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3124 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003125}
3126
3127// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3128// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003129bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003130 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003131 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3132 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003133}
3134
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003135bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003136 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003137 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3138
Chris Forbese0f511c2017-06-14 12:38:01 -07003139 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003140
3141 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003142 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 -06003143 VALIDATION_ERROR_01400726,
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003144 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003145 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003146 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003147
3148 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003149 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 -06003150 VALIDATION_ERROR_01400728,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003151 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003152 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003153 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003154
3155 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003156 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 -06003157 VALIDATION_ERROR_0140072a,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003158 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003159 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003160 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003161 return skip;
3162}
3163
3164void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3165 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3166 GetBufferMap(device_data)
3167 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3168}
3169
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003170bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3171 bool skip = false;
3172 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003173 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3174 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003175 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003176 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3177 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003178 skip |= ValidateBufferUsageFlags(
3179 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 -06003180 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003181 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003182 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003183}
3184
3185void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3186 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3187}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003188
3189// For the given format verify that the aspect masks make sense
3190bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3191 const char *func_name) {
3192 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3193 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003194 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003195 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003196 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 -06003197 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003198 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003199 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003200 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 -06003201 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003202 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003203 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003204 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003205 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003206 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 -06003207 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003208 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003209 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3210 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003211 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003212 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 -06003213 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003214 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003215 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3216 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003217 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003218 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003219 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003220 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 -06003221 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003222 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003223 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003224 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 -06003225 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003226 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003227 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003228 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003229 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003230 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 -06003231 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003232 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003233 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003234 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 -06003235 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003236 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003237 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003238 } else if (FormatIsMultiplane(format)) {
3239 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3240 if (3 == FormatPlaneCount(format)) {
3241 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3242 }
3243 if ((aspect_mask & valid_flags) != aspect_mask) {
3244 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3245 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
3246 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3247 "set, where n = [0, 1, 2].",
3248 func_name);
3249 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003250 }
3251 return skip;
3252}
3253
Petr Krausffa94af2017-08-08 21:46:02 +02003254struct SubresourceRangeErrorCodes {
3255 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3256};
3257
3258bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3259 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3260 const char *image_layer_count_var_name, const uint64_t image_handle,
3261 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003262 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3263 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003264
3265 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003266 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003267 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 -06003268 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003269 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003270 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3271 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003272 }
Petr Kraus4d718682017-05-18 03:38:41 +02003273
Petr Krausffa94af2017-08-08 21:46:02 +02003274 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3275 if (subresourceRange.levelCount == 0) {
3276 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 -06003277 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003278 } else {
3279 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003280
Petr Krausffa94af2017-08-08 21:46:02 +02003281 if (necessary_mip_count > image_mip_count) {
3282 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 -06003283 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003284 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003285 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003286 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003287 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003288 }
Petr Kraus4d718682017-05-18 03:38:41 +02003289 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003290 }
Petr Kraus4d718682017-05-18 03:38:41 +02003291
3292 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003293 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003294 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 -06003295 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003296 "%s: %s.baseArrayLayer (= %" PRIu32
3297 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3298 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003299 }
Petr Kraus4d718682017-05-18 03:38:41 +02003300
Petr Krausffa94af2017-08-08 21:46:02 +02003301 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3302 if (subresourceRange.layerCount == 0) {
3303 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 -06003304 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003305 } else {
3306 const uint64_t necessary_layer_count =
3307 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003308
Petr Krausffa94af2017-08-08 21:46:02 +02003309 if (necessary_layer_count > image_layer_count) {
3310 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 -06003311 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003312 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003313 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003314 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003315 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003316 }
Petr Kraus4d718682017-05-18 03:38:41 +02003317 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003318 }
Petr Kraus4d718682017-05-18 03:38:41 +02003319
Mark Lobodzinski602de982017-02-09 11:01:33 -07003320 return skip;
3321}
3322
Petr Krausffa94af2017-08-08 21:46:02 +02003323bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3324 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3325 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3326 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3327 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3328 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3329
3330 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3331 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3332
3333 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3334 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003335 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00d6c;
Petr Krausffa94af2017-08-08 21:46:02 +02003336 subresourceRangeErrorCodes.base_layer_err =
3337 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3338 subresourceRangeErrorCodes.layer_count_err =
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003339 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00d6e;
Petr Krausffa94af2017-08-08 21:46:02 +02003340
3341 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3342 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3343 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3344}
3345
3346bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3347 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3348 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3349 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003350 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800d38;
Petr Krausffa94af2017-08-08 21:46:02 +02003351 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003352 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800d3a;
Petr Krausffa94af2017-08-08 21:46:02 +02003353
3354 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3355 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3356 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3357}
3358
3359bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3360 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3361 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3362 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003363 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00d3c;
Petr Krausffa94af2017-08-08 21:46:02 +02003364 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003365 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00d3e;
Petr Krausffa94af2017-08-08 21:46:02 +02003366
3367 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3368 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3369 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3370}
3371
3372bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3373 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3374 const char *param_name) {
3375 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3376 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003377 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000d78;
Petr Krausffa94af2017-08-08 21:46:02 +02003378 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003379 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000d7a;
Petr Krausffa94af2017-08-08 21:46:02 +02003380
3381 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3382 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3383 subresourceRangeErrorCodes);
3384}
3385
Mark Lobodzinski602de982017-02-09 11:01:33 -07003386bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3387 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3388 bool skip = false;
3389 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3390 if (image_state) {
3391 skip |= ValidateImageUsageFlags(
3392 device_data, image_state,
3393 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houltona9df0ce2018-02-07 10:51:23 -07003394 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003395 false, -1, "vkCreateImageView()",
3396 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3397 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003398 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003399 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003400 skip |= ValidateCreateImageViewSubresourceRange(
3401 device_data, image_state,
3402 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3403 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003404
3405 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3406 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003407 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3408 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003409 VkFormat view_format = create_info->format;
3410 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003411 VkImageType image_type = image_state->createInfo.imageType;
3412 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003413
3414 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3415 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003416 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3417 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3418 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3419 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3420 std::stringstream ss;
3421 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3422 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3423 << ") format " << string_VkFormat(image_format)
3424 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3425 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3426 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 -06003427 VALIDATION_ERROR_0ac007f4, "%s", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06003428 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003429 }
3430 } else {
3431 // Format MUST be IDENTICAL to the format the image was created with
3432 if (image_format != view_format) {
3433 std::stringstream ss;
3434 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003435 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003436 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003437 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 -06003438 VALIDATION_ERROR_0ac007f6, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07003439 }
3440 }
3441
3442 // Validate correct image aspect bits for desired formats and format consistency
3443 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003444
3445 switch (image_type) {
3446 case VK_IMAGE_TYPE_1D:
3447 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3448 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 -06003449 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003450 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3451 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003452 }
3453 break;
3454 case VK_IMAGE_TYPE_2D:
3455 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3456 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3457 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3458 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 -06003459 VALIDATION_ERROR_0ac007d6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003460 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3461 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003462 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3463 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 -06003464 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003465 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3466 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003467 }
3468 }
3469 break;
3470 case VK_IMAGE_TYPE_3D:
3471 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3472 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3473 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3474 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003475 skip |=
3476 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 -06003477 VALIDATION_ERROR_0ac007da,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003478 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3479 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003480 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3481 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003482 skip |=
3483 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 -06003484 VALIDATION_ERROR_0ac007fa,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003485 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3486 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003487 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
3488 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003489 }
3490 } else {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003491 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 -06003492 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003493 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3494 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003495 }
3496 }
3497 } else {
3498 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3499 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 -06003500 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003501 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3502 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003503 }
3504 }
3505 break;
3506 default:
3507 break;
3508 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003509
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003510 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003511 bool check_tiling_features = false;
3512 VkFormatFeatureFlags tiling_features = 0;
3513 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3514 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3515 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3516 };
3517 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3518 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3519 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3520 };
3521 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3522 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003523 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003524 error_codes = linear_error_codes;
3525 check_tiling_features = true;
3526 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003527 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003528 error_codes = optimal_error_codes;
3529 check_tiling_features = true;
3530 }
3531
3532 if (check_tiling_features) {
3533 if (tiling_features == 0) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003534 skip |=
3535 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[0],
3536 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set.",
3537 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003538 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003539 skip |=
3540 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[1],
3541 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3542 "VK_IMAGE_USAGE_SAMPLED_BIT flags set.",
3543 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003544 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003545 skip |=
3546 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[2],
3547 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3548 "VK_IMAGE_USAGE_STORAGE_BIT flags set.",
3549 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003550 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3551 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003552 skip |=
3553 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[3],
3554 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3555 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set.",
3556 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003557 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3558 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003559 skip |=
3560 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[4],
3561 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3562 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set.",
3563 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003564 }
3565 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003566 }
3567 return skip;
3568}
3569
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003570void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3571 auto image_view_map = GetImageViewMap(device_data);
3572 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3573
3574 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003575 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003576 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3577 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003578}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003579
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003580bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3581 BUFFER_STATE *dst_buffer_state) {
3582 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003583 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3584 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003585 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003586 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3587 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3588 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3589 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003590 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003591 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003592 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003593 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003594 return skip;
3595}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003596
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003597void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3598 BUFFER_STATE *dst_buffer_state) {
3599 // Update bindings between buffers and cmd buffer
3600 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3601 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3602
3603 std::function<bool()> function = [=]() {
3604 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3605 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003606 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003607 function = [=]() {
3608 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3609 return false;
3610 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003611 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003612}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003613
3614static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3615 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3616 bool skip = false;
3617 auto buffer_state = GetBufferState(device_data, buffer);
3618 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003619 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 -06003620 DRAWSTATE_DOUBLE_DESTROY, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01003621 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003622 } else {
3623 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003624 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 -06003625 HandleToUint64(buffer), VALIDATION_ERROR_23c00734,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003626 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003627 }
3628 }
3629 return skip;
3630}
3631
3632bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3633 VK_OBJECT *obj_struct) {
3634 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003635 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003636 if (GetDisables(device_data)->destroy_image_view) return false;
3637 bool skip = false;
3638 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003639 skip |=
3640 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003641 }
3642 return skip;
3643}
3644
3645void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3646 VK_OBJECT obj_struct) {
3647 // Any bound cmd buffers are now invalid
3648 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3649 (*GetImageViewMap(device_data)).erase(image_view);
3650}
3651
3652bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3653 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003654 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003655 if (GetDisables(device_data)->destroy_buffer) return false;
3656 bool skip = false;
3657 if (*buffer_state) {
3658 skip |= validateIdleBuffer(device_data, buffer);
3659 }
3660 return skip;
3661}
3662
3663void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3664 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3665 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3666 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3667 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003668 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003669 }
3670 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003671 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003672 GetBufferMap(device_data)->erase(buffer_state->buffer);
3673}
3674
3675bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3676 VK_OBJECT *obj_struct) {
3677 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003678 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003679 if (GetDisables(device_data)->destroy_buffer_view) return false;
3680 bool skip = false;
3681 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003682 skip |=
3683 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003684 }
3685 return skip;
3686}
3687
3688void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3689 VK_OBJECT obj_struct) {
3690 // Any bound cmd buffers are now invalid
3691 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3692 GetBufferViewMap(device_data)->erase(buffer_view);
3693}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003694
3695bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3696 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003697 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003698 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003699 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003700 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3701 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003702 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003703 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003704 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003705 return skip;
3706}
3707
3708void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3709 std::function<bool()> function = [=]() {
3710 SetBufferMemoryValid(device_data, buffer_state, true);
3711 return false;
3712 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003713 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003714 // Update bindings between buffer and cmd buffer
3715 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003716}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003717
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003718bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3719 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003720 bool skip = false;
3721
3722 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003723 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3724 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003725 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 -06003726 HandleToUint64(image_state->image), VALIDATION_ERROR_0160018e,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003727 "%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 -06003728 "and 1, respectively.",
3729 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003730 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003731 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003732
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003733 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3734 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003735 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 -06003736 HandleToUint64(image_state->image), VALIDATION_ERROR_01600192,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003737 "%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 -06003738 "must be 0 and 1, respectively.",
3739 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003740 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003741 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003742
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003743 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3744 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003745 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 -06003746 HandleToUint64(image_state->image), VALIDATION_ERROR_016001aa,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003747 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
3748 "For 3D images these must be 0 and 1, respectively.",
3749 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003750 }
3751 }
3752
3753 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3754 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003755 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003756 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003757 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 -06003758 HandleToUint64(image_state->image), VALIDATION_ERROR_01600182,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003759 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003760 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
3761 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003762 }
3763
3764 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003765 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003766 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 -06003767 HandleToUint64(image_state->image), VALIDATION_ERROR_01600184,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003768 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
3769 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003770 }
3771
3772 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3773 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003774 skip |=
3775 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003776 HandleToUint64(image_state->image), VALIDATION_ERROR_01600186,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003777 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
3778 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003779 }
3780
3781 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3782 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3783 skip |= log_msg(
3784 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003785 HandleToUint64(image_state->image), VALIDATION_ERROR_01600188,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003786 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
3787 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003788 }
3789
3790 // subresource aspectMask must have exactly 1 bit set
3791 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3792 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3793 if (aspect_mask_bits.count() != 1) {
3794 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 -06003795 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003796 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003797 }
3798
3799 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003800 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003801 skip |= log_msg(
3802 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003803 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003804 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
3805 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003806 }
3807
3808 // Checks that apply only to compressed images
3809 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3810 // reserves a place for these compressed image checks. This block of code could move there once the image
3811 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003812 if (FormatIsCompressed(image_state->createInfo.format)) {
3813 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003814
3815 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003816 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003817 skip |= log_msg(
3818 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003819 HandleToUint64(image_state->image), VALIDATION_ERROR_01600196,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003820 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
3821 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003822 }
3823
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003824 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003825 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003826 skip |= log_msg(
3827 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003828 HandleToUint64(image_state->image), VALIDATION_ERROR_01600198,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003829 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
3830 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003831 }
3832
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003833 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003834 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3835 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3836 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003837 skip |=
3838 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003839 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019a,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003840 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3841 "width & height (%d, %d)..",
3842 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003843 }
3844
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003845 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003846 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3847 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003848 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 -06003849 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019c,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003850 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3851 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
3852 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003853 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003854
3855 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003856 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003857 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003858 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3859 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 -06003860 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019e,
Dave Houlton75967fc2017-03-06 17:21:16 -07003861 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003862 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003863 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003864 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07003865 }
3866
3867 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003868 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003869 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3870 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 -06003871 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a0,
Dave Houlton75967fc2017-03-06 17:21:16 -07003872 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003873 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003874 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003875 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07003876 }
3877
3878 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003879 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003880 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3881 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 -06003882 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a2,
Dave Houlton75967fc2017-03-06 17:21:16 -07003883 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003884 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003885 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003886 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07003887 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003888 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003889 }
3890
3891 return skip;
3892}
3893
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003894static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3895 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003896 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003897 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003898
3899 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003900 VkExtent3D extent = pRegions[i].imageExtent;
3901 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003902
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003903 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3904 {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003905 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3906 (uint64_t)0, IMAGE_ZERO_AREA_SUBREGION, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
3907 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003908 }
3909
3910 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3911
3912 // 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 -06003913 if (FormatIsCompressed(image_info->format)) {
3914 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003915 if (image_extent.width % block_extent.width) {
3916 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3917 }
3918 if (image_extent.height % block_extent.height) {
3919 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3920 }
3921 if (image_extent.depth % block_extent.depth) {
3922 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3923 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003924 }
3925
Dave Houltonfc1a4052017-04-27 14:32:45 -06003926 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003927 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 -06003928 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003929 }
3930 }
3931
3932 return skip;
3933}
3934
Chris Forbese8ba09a2017-06-01 17:39:02 -07003935static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003936 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3937 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003938 bool skip = false;
3939
3940 VkDeviceSize buffer_size = buff_state->createInfo.size;
3941
3942 for (uint32_t i = 0; i < regionCount; i++) {
3943 VkExtent3D copy_extent = pRegions[i].imageExtent;
3944
3945 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3946 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003947 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003948
Dave Houltonf3229d52017-02-21 15:59:08 -07003949 // Handle special buffer packing rules for specific depth/stencil formats
3950 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003951 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003952 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3953 switch (image_state->createInfo.format) {
3954 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003955 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003956 break;
3957 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003958 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003959 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003960 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003961 case VK_FORMAT_D24_UNORM_S8_UINT:
3962 unit_size = 4;
3963 break;
3964 default:
3965 break;
3966 }
3967 }
3968
Dave Houlton1d2022c2017-03-29 11:43:58 -06003969 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003970 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003971 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003972 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3973 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3974
3975 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3976 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3977 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003978 }
3979
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003980 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3981 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3982 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003983 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003984 } else {
3985 // Calculate buffer offset of final copied byte, + 1.
3986 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3987 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3988 max_buffer_offset *= unit_size; // convert to bytes
3989 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003990
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003991 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003992 skip |=
3993 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
3994 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003995 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003996 }
3997 }
3998
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003999 return skip;
4000}
4001
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004002bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004003 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004004 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004005 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4006 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4007
4008 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004009 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004010
4011 // Command pool must support graphics, compute, or transfer operations
4012 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4013
4014 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4015 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4016 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 -06004017 HandleToUint64(cb_node->createInfo.commandPool), VALIDATION_ERROR_19202415,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004018 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004019 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004020 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004021 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004022 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004023 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004024 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004025
4026 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004027 VALIDATION_ERROR_19200178);
4028 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
4029 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004030
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004031 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004032 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004033 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004034 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4035 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
4036 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004037 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004038 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004039 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
4040 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
4041 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004042 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06004043 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004044 }
4045 return skip;
4046}
4047
4048void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004049 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4050 VkImageLayout src_image_layout) {
4051 // Make sure that all image slices are updated to correct layout
4052 for (uint32_t i = 0; i < region_count; ++i) {
4053 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4054 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004055 // Update bindings between buffer/image and cmd buffer
4056 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004057 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004058
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004059 std::function<bool()> function = [=]() {
4060 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
4061 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004062 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004063 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004064 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004065 return false;
4066 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004067 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004068}
4069
4070bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004071 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004072 const VkBufferImageCopy *pRegions, const char *func_name) {
4073 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4074 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4075
4076 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004077 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004078
4079 // Command pool must support graphics, compute, or transfer operations
4080 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4081 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4082 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4083 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 -06004084 HandleToUint64(cb_node->createInfo.commandPool), VALIDATION_ERROR_18e02415,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004085 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004086 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004087 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004088 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004089 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004090 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004091 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004092 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004093 VALIDATION_ERROR_18e00166);
4094 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4095 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4096 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4097 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4098 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004099 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004100 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004101 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004102 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004103 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4104 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4105 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004106 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4107 "vkCmdCopyBufferToImage()");
4108 }
4109 return skip;
4110}
4111
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004112void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004113 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4114 VkImageLayout dst_image_layout) {
4115 // Make sure that all image slices are updated to correct layout
4116 for (uint32_t i = 0; i < region_count; ++i) {
4117 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4118 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004119 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004120 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004121 std::function<bool()> function = [=]() {
4122 SetImageMemoryValid(device_data, dst_image_state, true);
4123 return false;
4124 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004125 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004126 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004127 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004128}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004129
4130bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4131 const auto report_data = core_validation::GetReportData(device_data);
4132 bool skip = false;
4133 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4134
Dave Houlton1d960ff2018-01-19 12:17:05 -07004135 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004136 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4137 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4138 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004139 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 -06004140 VALIDATION_ERROR_2a6007ca,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004141 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004142 }
4143
4144 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4145 if (!image_entry) {
4146 return skip;
4147 }
4148
Dave Houlton1d960ff2018-01-19 12:17:05 -07004149 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004150 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004151 skip |=
4152 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4153 VALIDATION_ERROR_2a6007c8, "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004154 }
4155
Dave Houlton1d960ff2018-01-19 12:17:05 -07004156 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004157 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004158 skip |=
4159 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4160 VALIDATION_ERROR_2a600d68, "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.",
4161 pSubresource->mipLevel, image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004162 }
4163
Dave Houlton1d960ff2018-01-19 12:17:05 -07004164 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004165 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004166 skip |=
4167 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4168 VALIDATION_ERROR_2a600d6a, "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4169 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004170 }
4171
Dave Houlton1d960ff2018-01-19 12:17:05 -07004172 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004173 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004174 if (FormatIsMultiplane(img_format)) {
4175 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4176 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4177 if (FormatPlaneCount(img_format) > 2u) {
4178 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4179 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4180 }
4181 if (sub_aspect != (sub_aspect & allowed_flags)) {
4182 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 -06004183 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004184 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004185 ") must be a single-plane specifier flag.",
4186 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004187 }
4188 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004189 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004190 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004191 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Mark Lobodzinski88529492018-04-01 10:38:15 -06004192 VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004193 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004194 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004195 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004196 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004197 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 -06004198 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mike Weiblen672b58b2017-02-21 14:32:53 -07004199 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004200 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004201 }
4202 }
4203 return skip;
4204}