blob: 48212e1a83c81dbe2a860514c77c4617cd281884 [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),
97 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
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),
104 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
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),
128 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
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,
Petr Krausbc7f5442017-05-14 23:43:38 +0200315 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
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,
338 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
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,
391 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer), __LINE__,
392 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
393 "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 Houlton1d2022c2017-03-29 11:43:58 -0600436 if (!FormatIsColor(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 Lobodzinski0827aec2017-03-21 16:41:45 -0600496 skip |=
497 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200498 HandleToUint64(img_barrier->image), __LINE__, msg_code, "DS",
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600499 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ". %s",
Petr Kraus13c98a62017-12-09 00:22:39 +0100500 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
501 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags, validation_error_map[msg_code]);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700502 }
503 return skip;
504}
505
506// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600507bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700508 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700509 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700510
Mike Weiblen62d08a32017-03-07 22:18:27 -0700511 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
512 auto img_barrier = &pImageMemoryBarriers[i];
513 if (!img_barrier) continue;
514
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600515 auto image_state = GetImageState(device_data, img_barrier->image);
516 if (image_state) {
517 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
518 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
519 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
520
521 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
522 if (image_state->layout_locked) {
523 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600524 skip |= log_msg(
525 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600526 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, 0, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100527 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600528 " 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 +0100529 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600530 string_VkImageLayout(img_barrier->newLayout));
531 }
532 }
533
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600534 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600535 // For a Depth/Stencil image both aspects MUST be set
536 if (FormatIsDepthAndStencil(image_create_info->format)) {
537 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
538 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
539 if ((aspect_mask & ds_mask) != (ds_mask)) {
Petr Kraus13c98a62017-12-09 00:22:39 +0100540 skip |= log_msg(
541 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
542 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), __LINE__, VALIDATION_ERROR_0a00096e,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700543 "DS",
544 "%s: Image barrier 0x%p references image 0x%" PRIx64
545 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ". %s",
Petr Kraus13c98a62017-12-09 00:22:39 +0100546 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
547 string_VkFormat(image_create_info->format), aspect_mask, validation_error_map[VALIDATION_ERROR_0a00096e]);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600548 }
549 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600550 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
551 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700552
Mike Weiblen62d08a32017-03-07 22:18:27 -0700553 for (uint32_t j = 0; j < level_count; j++) {
554 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
555 for (uint32_t k = 0; k < layer_count; k++) {
556 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600557 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
558 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
559 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
560 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700561 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
562 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
563 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
564 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
565 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
566 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
567 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
568 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700569 }
570 }
571 }
572 return skip;
573}
574
Chris Forbes4de4b132017-08-21 11:27:08 -0700575static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
576 if (barrier->srcQueueFamilyIndex == barrier->dstQueueFamilyIndex)
577 return false;
578
579 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
580 return pool->queueFamilyIndex == barrier->srcQueueFamilyIndex;
581}
582
Chris Forbes399a6782017-08-18 15:00:48 -0700583void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700584 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700585 for (uint32_t i = 0; i < memBarrierCount; ++i) {
586 auto mem_barrier = &pImgMemBarriers[i];
587 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700588
Chris Forbes4de4b132017-08-21 11:27:08 -0700589 // For ownership transfers, the barrier is specified twice; as a release
590 // operation on the yielding queue family, and as an acquire operation
591 // on the acquiring queue family. This barrier may also include a layout
592 // transition, which occurs 'between' the two operations. For validation
593 // purposes it doesn't seem important which side performs the layout
594 // transition, but it must not be performed twice. We'll arbitrarily
595 // choose to perform it as part of the acquire operation.
596 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
597 continue;
598 }
599
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600600 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
601 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
602 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
603
Dave Houltonb3f4b282018-02-22 16:25:16 -0700604 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
605 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
606 // for all (potential) layer sub_resources.
607 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
608 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
609 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
610 }
611
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600612 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700613 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600614 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700615 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Chris Forbes399a6782017-08-18 15:00:48 -0700616 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
617 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
618 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
619 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700620 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Chris Forbes399a6782017-08-18 15:00:48 -0700621 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
622 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
623 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700624 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700625 }
626 }
627 }
628}
629
Tobin Ehlisc8266452017-04-07 12:20:30 -0600630bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600631 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600632 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700633 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600634 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600635 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700636
637 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
638 uint32_t layer = i + subLayers.baseArrayLayer;
639 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
640 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600641 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
642 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600643 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600644 // TODO: Improve log message in the next pass
Petr Kraus13c98a62017-12-09 00:22:39 +0100645 skip |= log_msg(
646 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
647 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
648 "%s: Cannot use image 0x%" PRIx64 " with specific layout %s that doesn't match the actual current layout %s.",
649 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600650 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700651 }
652 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600653 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
654 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
655 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700656 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
657 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600658 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200659 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer), __LINE__,
660 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100661 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
662 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700663 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600664 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600665 if (image_state->shared_presentable) {
666 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
667 // TODO: Add unique error id when available.
668 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
669 __LINE__, msg_code, "DS",
670 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
671 string_VkImageLayout(optimal_layout));
672 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600673 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700674 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600675 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600676 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200677 HandleToUint64(cb_node->commandBuffer), __LINE__, msg_code, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100678 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL. %s", caller,
679 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout),
680 validation_error_map[msg_code]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700681 }
682 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600683 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700684}
685
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700686void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
687 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700688 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700689 if (!renderPass) return;
690
691 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
692 if (framebuffer_state) {
693 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
694 auto image_view = framebuffer_state->createInfo.pAttachments[i];
695 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
696 }
697 }
698}
Dave Houltone19e20d2018-02-02 16:32:41 -0700699
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700700bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700701 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600702 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700703 const debug_report_data *report_data = core_validation::GetReportData(device_data);
704
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600705 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600706 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600707 VALIDATION_ERROR_09e0075e, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
708 validation_error_map[VALIDATION_ERROR_09e0075e]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600709
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600710 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600711 }
712
Dave Houlton130c0212018-01-29 13:39:56 -0700713 bool optimal_tiling = (VK_IMAGE_TILING_OPTIMAL == pCreateInfo->tiling);
714 const char *tiling_string = string_VkImageTiling(pCreateInfo->tiling);
715 const char *format_string = string_VkFormat(pCreateInfo->format);
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600716 VkFormatProperties properties = GetFormatProperties(device_data, pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700717 VkFormatFeatureFlags features = (optimal_tiling ? properties.optimalTilingFeatures : properties.linearTilingFeatures);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600718
Dave Houlton130c0212018-01-29 13:39:56 -0700719 if (0 == features) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600720 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700721 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ac : VALIDATION_ERROR_09e007a2);
722 ss << "vkCreateImage format parameter " << format_string << " is an unsupported format";
723 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
724 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600725 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600726 }
727
Dave Houlton130c0212018-01-29 13:39:56 -0700728 if ((pCreateInfo->usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600729 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700730 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ae : VALIDATION_ERROR_09e007a4);
731 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_SAMPLED_BIT is not supported for format " << format_string << " with tiling "
732 << tiling_string;
733 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
734 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
735 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600736
Dave Houlton130c0212018-01-29 13:39:56 -0700737 if ((pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
738 std::stringstream ss;
739 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b0 : VALIDATION_ERROR_09e007a6);
740 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_STORAGE_BIT is not supported for format " << format_string << " with tiling "
741 << tiling_string;
742 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
743 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600744 }
745
Lenny Komowb79f04a2017-09-18 17:07:00 -0600746 // TODO: Add checks for EXTENDED_USAGE images to validate images are compatible
747 // For EXTENDED_USAGE images, format can match any image COMPATIBLE with original image
748 if (!GetDeviceExtensions(device_data)->vk_khr_maintenance2 || !(pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR)) {
749 // Validate that format supports usage as color attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700750 if ((pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
751 (0 == (features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT))) {
752 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b2 : VALIDATION_ERROR_09e007a8);
753 std::stringstream ss;
754 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_COLOR_ATTACHMENT is not supported for format " << format_string
755 << " with tiling " << tiling_string;
756 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
757 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600758 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600759
Lenny Komowb79f04a2017-09-18 17:07:00 -0600760 // Validate that format supports usage as depth/stencil attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700761 if ((pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
762 (0 == (features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
763 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b4 : VALIDATION_ERROR_09e007aa);
764 std::stringstream ss;
765 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT is not supported for format " << format_string
766 << " with tiling " << tiling_string;
767 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
768 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
769 }
770 }
771
772 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
773 std::stringstream ss;
774 ss << "vkCreateImage: Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set";
775 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
776 VALIDATION_ERROR_09e0076a, "IMAGE", "%s. %s", ss.str().c_str(),
777 validation_error_map[VALIDATION_ERROR_09e0076a]);
778 }
779
780 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
781 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
782 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
783 if (VK_SUCCESS != err) {
784 std::stringstream ss;
785 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
786 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
787 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
788 VALIDATION_ERROR_09e00758, "IMAGE", "%s. %s", ss.str().c_str(),
789 validation_error_map[VALIDATION_ERROR_09e00758]);
790 return skip;
791 }
792
793 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
794 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
795 std::stringstream ss;
796 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
797 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
798 VALIDATION_ERROR_09e0076e, "IMAGE", "%s. %s", ss.str().c_str(),
799 validation_error_map[VALIDATION_ERROR_09e0076e]);
800 }
801
802 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
803 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
804 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
805 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, 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 format " << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600808 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Dave Houlton130c0212018-01-29 13:39:56 -0700809 VALIDATION_ERROR_09e00770, "IMAGE", "%s. %s", ss.str().c_str(),
810 validation_error_map[VALIDATION_ERROR_09e00770]);
Lenny Komowb79f04a2017-09-18 17:07:00 -0600811 }
Dave Houlton130c0212018-01-29 13:39:56 -0700812 } else {
813 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
814 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600815 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700816 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
817 "format "
818 << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600819 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Dave Houlton130c0212018-01-29 13:39:56 -0700820 VALIDATION_ERROR_09e00772, "IMAGE", "%s. %s", ss.str().c_str(),
821 validation_error_map[VALIDATION_ERROR_09e00772]);
Lenny Komowb79f04a2017-09-18 17:07:00 -0600822 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600823 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700824 }
825
Dave Houlton130c0212018-01-29 13:39:56 -0700826 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
827 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
828 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
829 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
830 std::stringstream ss;
831 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
832 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
833 VALIDATION_ERROR_09e00776, "IMAGE", "%s. %s", ss.str().c_str(),
834 validation_error_map[VALIDATION_ERROR_09e00776]);
835 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700836 }
837
Dave Houlton130c0212018-01-29 13:39:56 -0700838 // 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 -0700839 // 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 -0700840 // implementation shown. DJH
841 //
842 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
843 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
844 // device_limits->maxImageDimension3D)) {
845 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
846 std::stringstream ss;
847 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
848 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
849 VALIDATION_ERROR_09e0077e, "IMAGE", "%s. %s", ss.str().c_str(),
850 validation_error_map[VALIDATION_ERROR_09e0077e]);
851 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700852
Dave Houlton130c0212018-01-29 13:39:56 -0700853 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
854 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
855 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
856 std::stringstream ss;
857 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
858 "maxFramebufferWidth";
859 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
860 VALIDATION_ERROR_09e00788, "IMAGE", "%s. %s", ss.str().c_str(),
861 validation_error_map[VALIDATION_ERROR_09e00788]);
862 }
863
864 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
865 std::stringstream ss;
866 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
867 "maxFramebufferHeight";
868 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
869 VALIDATION_ERROR_09e0078a, "IMAGE", "%s. %s", ss.str().c_str(),
870 validation_error_map[VALIDATION_ERROR_09e0078a]);
871 }
872
873 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
874 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
875 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
876
877 // Round up to imageGranularity boundary
878 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
879 uint64_t ig_mask = imageGranularity - 1;
880 total_size = (total_size + ig_mask) & ~ig_mask;
881
882 if (total_size > format_limits.maxResourceSize) {
Petr Kraus131a4a92018-03-14 19:53:58 +0100883 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600884 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
Dave Houltona9df0ce2018-02-07 10:51:23 -0700885 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
886 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -0700887 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700888 }
889
Dave Houlton130c0212018-01-29 13:39:56 -0700890 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600891 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
Dave Houlton130c0212018-01-29 13:39:56 -0700892 VALIDATION_ERROR_09e00780, "Image",
893 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s",
894 pCreateInfo->arrayLayers, format_limits.maxArrayLayers, validation_error_map[VALIDATION_ERROR_09e00780]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700895 }
896
Dave Houlton130c0212018-01-29 13:39:56 -0700897 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600898 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600899 VALIDATION_ERROR_09e0078e, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Dave Houlton130c0212018-01-29 13:39:56 -0700900 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600901 validation_error_map[VALIDATION_ERROR_09e0078e]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700902 }
903
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600904 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600905 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
906 DRAWSTATE_INVALID_FEATURE, "DS",
907 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
908 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600909 }
910
Lenny Komowb79f04a2017-09-18 17:07:00 -0600911 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
912 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
913 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
914 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
915 // TODO: Add Maintenance2 VUID
916 skip |=
917 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
918 VALIDATION_ERROR_UNDEFINED, "DS",
919 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
920 "format must be block, ETC or ASTC compressed, but is %s",
921 string_VkFormat(pCreateInfo->format));
922 }
923 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
924 // TODO: Add Maintenance2 VUID
925 skip |=
926 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
927 VALIDATION_ERROR_UNDEFINED, "DS",
928 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
929 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
930 }
931 }
932 }
933
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600934 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700935}
936
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700937void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700938 IMAGE_LAYOUT_NODE image_state;
939 image_state.layout = pCreateInfo->initialLayout;
940 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700941 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 -0700942 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700943 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
944 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700945}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700946
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700947bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700948 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700949 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200950 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700951 if (disabled->destroy_image) return false;
952 bool skip = false;
953 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600954 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
955 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700956 }
957 return skip;
958}
959
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700960void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700961 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
962 // Clean up memory mapping, bindings and range references for image
963 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700964 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700965 if (mem_info) {
966 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
967 }
968 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600969 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700970 // Remove image from imageMap
971 core_validation::GetImageMap(device_data)->erase(image);
972 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
973 core_validation::GetImageSubresourceMap(device_data);
974
975 const auto &sub_entry = imageSubresourceMap->find(image);
976 if (sub_entry != imageSubresourceMap->end()) {
977 for (const auto &pair : sub_entry->second) {
978 core_validation::GetImageLayoutMap(device_data)->erase(pair);
979 }
980 imageSubresourceMap->erase(sub_entry);
981 }
982}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700983
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700984bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700985 bool skip = false;
986 const debug_report_data *report_data = core_validation::GetReportData(device_data);
987
988 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
989 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
990 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200991 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700992 }
993
Dave Houlton1d2022c2017-03-29 11:43:58 -0600994 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700995 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
996 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600997 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
998 validation_error_map[VALIDATION_ERROR_1880000e]);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600999 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001000 char const str[] = "vkCmdClearColorImage called with compressed image.";
1001 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001002 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
1003 validation_error_map[VALIDATION_ERROR_1880000e]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001004 }
1005
1006 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1007 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1008 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001009 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_18800004, "IMAGE", "%s. %s", str,
1010 validation_error_map[VALIDATION_ERROR_18800004]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001011 }
1012 return skip;
1013}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001014
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001015uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1016 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1017 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001018 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001019 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001020 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001021 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001022}
1023
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001024uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1025 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1026 uint32_t array_layer_count = range->layerCount;
1027 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1028 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001029 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001030 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001031}
1032
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001033bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001034 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1035 bool skip = false;
1036 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1037
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001038 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1039 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001040
1041 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1042 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001043 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1044 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001045 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001046 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001047 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1048 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001049 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001050 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001051 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001052 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton33c2d252017-06-09 17:08:32 -06001053 HandleToUint64(image_state->image), __LINE__, 0, "DS",
1054 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1055 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001056
1057 } else {
1058 if (image_state->shared_presentable) {
1059 skip |= log_msg(
1060 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001061 HandleToUint64(image_state->image), __LINE__, 0, "DS",
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001062 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1063 string_VkImageLayout(dest_image_layout));
1064 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001065 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001066 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001067 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001068 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001069 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001070 } else {
1071 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1072 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001073 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001074 HandleToUint64(image_state->image), __LINE__, error_code, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001075 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL. %s", func_name,
1076 string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001077 }
1078 }
1079
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001080 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1081 uint32_t level = level_index + range.baseMipLevel;
1082 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1083 uint32_t layer = layer_index + range.baseArrayLayer;
1084 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001085 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001086 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001087 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001088 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001089 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001090 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001091 } else {
1092 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1093 }
1094 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1095 __LINE__, error_code, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001096 "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s. %s",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001097 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
1098 validation_error_map[error_code]);
1099 }
1100 }
1101 }
1102 }
1103
1104 return skip;
1105}
1106
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001107void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1108 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001109 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1110 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1111 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001112
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001113 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1114 uint32_t level = level_index + range.baseMipLevel;
1115 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1116 uint32_t layer = layer_index + range.baseArrayLayer;
1117 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001118 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001119 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1120 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 -07001121 }
1122 }
1123 }
1124}
1125
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001126bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001127 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1128 bool skip = false;
1129 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001130 auto cb_node = GetCBNode(dev_data, commandBuffer);
1131 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001132 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001133 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001134 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001135 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001136 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001137 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001138 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001139 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001140 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001141 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001142 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001143 }
1144 }
1145 return skip;
1146}
1147
1148// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001149void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001150 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001151 auto cb_node = GetCBNode(dev_data, commandBuffer);
1152 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001153 if (cb_node && image_state) {
1154 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1155 std::function<bool()> function = [=]() {
1156 SetImageMemoryValid(dev_data, image_state, true);
1157 return false;
1158 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001159 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001160 for (uint32_t i = 0; i < rangeCount; ++i) {
1161 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1162 }
1163 }
1164}
1165
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001166bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1167 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001168 const VkImageSubresourceRange *pRanges) {
1169 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001170 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1171
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001172 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001173 auto cb_node = GetCBNode(device_data, commandBuffer);
1174 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001175 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001176 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001177 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001178 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001179 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001180 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001181 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001182 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001183 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001184 skip |=
1185 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001186 // Image aspect must be depth or stencil or both
1187 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1188 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1189 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001190 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1191 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001192 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001193 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001194 }
1195 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001196 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001197 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001198 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1199 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a0001c, "IMAGE", "%s. %s", str,
1200 validation_error_map[VALIDATION_ERROR_18a0001c]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001201 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001202 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1203 char const str[] =
1204 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1205 "set.";
1206 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1207 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00012, "IMAGE", "%s. %s", str,
1208 validation_error_map[VALIDATION_ERROR_18a00012]);
1209 }
1210 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1211 VkImageTiling tiling = image_state->createInfo.tiling;
1212 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1213 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1214 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
1215 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1216 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00010, "IMAGE",
1217 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1218 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR. %s",
1219 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling),
1220 validation_error_map[VALIDATION_ERROR_18a00010]);
1221 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001222 }
1223 return skip;
1224}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001225
1226// Returns true if [x, xoffset] and [y, yoffset] overlap
1227static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1228 bool result = false;
1229 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1230 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1231
1232 if (intersection_max > intersection_min) {
1233 result = true;
1234 }
1235 return result;
1236}
1237
1238// Returns true if two VkImageCopy structures overlap
Dave Houltonf5217612018-02-02 16:18:52 -07001239static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001240 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001241
1242 if (is_multiplane && (src->srcSubresource.aspectMask != dst->dstSubresource.aspectMask)) {
1243 return result;
1244 }
1245
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001246 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1247 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1248 dst->dstSubresource.layerCount))) {
1249 result = true;
1250 switch (type) {
1251 case VK_IMAGE_TYPE_3D:
1252 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1253 // Intentionally fall through to 2D case
1254 case VK_IMAGE_TYPE_2D:
1255 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1256 // Intentionally fall through to 1D case
1257 case VK_IMAGE_TYPE_1D:
1258 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1259 break;
1260 default:
1261 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1262 assert(false);
1263 }
1264 }
1265 return result;
1266}
1267
Dave Houltonfc1a4052017-04-27 14:32:45 -06001268// Returns non-zero if offset and extent exceed image extents
1269static const uint32_t x_bit = 1;
1270static const uint32_t y_bit = 2;
1271static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001272static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001273 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001274 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001275 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1276 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001277 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001278 }
1279 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1280 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001281 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001282 }
1283 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1284 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001285 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001286 }
1287 return result;
1288}
1289
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001290// Test if two VkExtent3D structs are equivalent
1291static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1292 bool result = true;
1293 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1294 (extent->depth != other_extent->depth)) {
1295 result = false;
1296 }
1297 return result;
1298}
1299
Dave Houltonee281a52017-12-08 13:51:02 -07001300// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1301// Destination image texel extents must be adjusted by block size for the dest validation checks
1302VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1303 VkExtent3D adjusted_extent = extent;
1304 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1305 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1306 adjusted_extent.width /= block_size.width;
1307 adjusted_extent.height /= block_size.height;
1308 adjusted_extent.depth /= block_size.depth;
1309 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1310 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1311 adjusted_extent.width *= block_size.width;
1312 adjusted_extent.height *= block_size.height;
1313 adjusted_extent.depth *= block_size.depth;
1314 }
1315 return adjusted_extent;
1316}
1317
Dave Houlton6f9059e2017-05-02 17:15:13 -06001318// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001319static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1320 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001321
1322 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001323 if (mip >= img->createInfo.mipLevels) {
1324 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001325 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001326
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001327 // 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 -06001328 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001329 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1330 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1331 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001332
Dave Houlton6f9059e2017-05-02 17:15:13 -06001333 // Image arrays have an effective z extent that isn't diminished by mip level
1334 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001335 extent.depth = img->createInfo.arrayLayers;
1336 }
1337
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001338 return extent;
1339}
1340
1341// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001342static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001343 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1344}
1345
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001346// Test if the extent argument has any dimensions set to 0.
1347static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1348 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1349}
1350
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001351// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1352static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1353 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1354 VkExtent3D granularity = {0, 0, 0};
1355 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1356 if (pPool) {
1357 granularity =
1358 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001359 if (FormatIsCompressed(img->createInfo.format)) {
1360 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001361 granularity.width *= block_size.width;
1362 granularity.height *= block_size.height;
1363 }
1364 }
1365 return granularity;
1366}
1367
1368// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1369static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1370 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001371 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1372 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001373 valid = false;
1374 }
1375 return valid;
1376}
1377
1378// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1379static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1380 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1381 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1382 bool skip = false;
1383 VkExtent3D offset_extent = {};
1384 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1385 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1386 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001387 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001388 // 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 -07001389 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001390 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1391 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001392 "%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 "
1393 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001394 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001395 }
1396 } else {
1397 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1398 // integer multiples of the image transfer granularity.
1399 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001400 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1401 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001402 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1403 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001404 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1405 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001406 }
1407 }
1408 return skip;
1409}
1410
1411// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1412static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1413 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001414 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001415 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1416 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001417 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001418 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1419 // subresource extent.
1420 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001421 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1422 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1423 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1424 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1425 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1426 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001427 }
1428 } else {
1429 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1430 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1431 // subresource extent dimensions.
1432 VkExtent3D offset_extent_sum = {};
1433 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1434 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1435 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001436 bool x_ok = true;
1437 bool y_ok = true;
1438 bool z_ok = true;
1439 switch (image_type) {
1440 case VK_IMAGE_TYPE_3D:
1441 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1442 (subresource_extent->depth == offset_extent_sum.depth));
1443 // Intentionally fall through to 2D case
1444 case VK_IMAGE_TYPE_2D:
1445 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1446 (subresource_extent->height == offset_extent_sum.height));
1447 // Intentionally fall through to 1D case
1448 case VK_IMAGE_TYPE_1D:
1449 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1450 (subresource_extent->width == offset_extent_sum.width));
1451 break;
1452 default:
1453 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1454 assert(false);
1455 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001456 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001457 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1458 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1459 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1460 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1461 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1462 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1463 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1464 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001465 }
1466 }
1467 return skip;
1468}
1469
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001470// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001471bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1472 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1473 const uint32_t i, const char *function) {
1474 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001475 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001476 // TODO: Add granularity checking for compressed formats
1477
1478 // bufferRowLength must be a multiple of the compressed texel block width
1479 // bufferImageHeight must be a multiple of the compressed texel block height
1480 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1481 // bufferOffset must be a multiple of the compressed texel block size in bytes
1482 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1483 // must equal the image subresource width
1484 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1485 // must equal the image subresource height
1486 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1487 // must equal the image subresource depth
1488 } else {
1489 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001490 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1491 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1492 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001493 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001494 }
1495 return skip;
1496}
1497
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001498// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001499bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001500 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1501 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001502 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001503 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001504 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001505 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001506 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001507 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001508 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001509 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001510
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001511 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001512 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001513 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houltonee281a52017-12-08 13:51:02 -07001514 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001515 const VkExtent3D dest_effective_extent =
1516 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001517 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001518 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001519 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001520 return skip;
1521}
1522
Dave Houlton6f9059e2017-05-02 17:15:13 -06001523// Validate contents of a VkImageCopy struct
1524bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1525 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1526 bool skip = false;
1527
1528 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001529 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001530
1531 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001532 const VkExtent3D src_copy_extent = region.extent;
1533 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001534 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1535
Dave Houlton6f9059e2017-05-02 17:15:13 -06001536 bool slice_override = false;
1537 uint32_t depth_slices = 0;
1538
1539 // Special case for copying between a 1D/2D array and a 3D image
1540 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1541 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001542 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001543 slice_override = (depth_slices != 1);
1544 } 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 -07001545 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001546 slice_override = (depth_slices != 1);
1547 }
1548
1549 // Do all checks on source image
1550 //
1551 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001552 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1553 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1554 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00124, "IMAGE",
1555 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
1556 "be 0 and 1, respectively. %s",
1557 i, region.srcOffset.y, src_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00124]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001558 }
1559 }
1560
Dave Houlton533be9f2018-03-26 17:08:30 -06001561 // VUID-VkImageCopy-srcImage-01785
1562 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1563 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1564 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00df2, "IMAGE",
1565 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
1566 "these must be 0 and 1, respectively. %s",
1567 i, region.srcOffset.z, src_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00df2]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001568 }
1569
Dave Houlton533be9f2018-03-26 17:08:30 -06001570 // VUID-VkImageCopy-srcImage-01787
1571 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1572 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1573 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00df6, "IMAGE",
1574 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0. %s", i,
1575 region.srcOffset.z, validation_error_map[VALIDATION_ERROR_09c00df6]);
1576 }
1577
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001578 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001579 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001580 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001581 skip |=
1582 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001583 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001584 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
1585 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001586 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001587 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001588 }
1589 }
1590 } else { // Pre maint 1
1591 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001592 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001593 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1594 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1595 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1596 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
1597 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001598 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001599 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001600 }
1601 }
1602 }
1603
Dave Houlton6f9059e2017-05-02 17:15:13 -06001604 // Checks that apply only to compressed images
1605 if (FormatIsCompressed(src_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001606 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001607
1608 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001609 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1610 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1611 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001612 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001613 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001614 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
1615 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001616 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001617 validation_error_map[VALIDATION_ERROR_09c0013a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001618 }
1619
Dave Houlton94a00372017-12-14 15:08:47 -07001620 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001621 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1622 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001623 skip |=
1624 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001625 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013c, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001626 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1627 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001628 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001629 validation_error_map[VALIDATION_ERROR_09c0013c]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001630 }
1631
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001632 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001633 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1634 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001635 skip |=
1636 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001637 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013e, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001638 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1639 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001640 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001641 validation_error_map[VALIDATION_ERROR_09c0013e]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001642 }
1643
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001644 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001645 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1646 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001647 skip |=
1648 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001649 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00140, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001650 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1651 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001652 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001653 validation_error_map[VALIDATION_ERROR_09c00140]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001654 }
1655 } // Compressed
1656
1657 // Do all checks on dest image
1658 //
1659 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001660 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001661 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1662 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00130, "IMAGE",
1663 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
1664 "these must be 0 and 1, respectively. %s",
1665 i, region.dstOffset.y, dst_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00130]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001666 }
1667 }
1668
Dave Houlton533be9f2018-03-26 17:08:30 -06001669 // VUID-VkImageCopy-dstImage-01786
1670 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
1671 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1672 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00df4, "IMAGE",
1673 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
1674 "and 1, respectively. %s",
1675 i, region.dstOffset.z, dst_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00df4]);
1676 }
1677
1678 // VUID-VkImageCopy-dstImage-01788
1679 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
1680 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1681 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00df8, "IMAGE",
1682 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0. %s", i,
1683 region.dstOffset.z, validation_error_map[VALIDATION_ERROR_09c00df8]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001684 }
1685
1686 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001687 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001689 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001690 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1691 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001692 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001693 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001694 }
1695 }
1696 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001697 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001698 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001699 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001700 skip |=
1701 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001702 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001703 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1704 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001705 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001706 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001707 }
1708 }
1709 } else { // Pre maint 1
1710 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001711 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001712 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1713 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1714 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1715 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
1716 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001717 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001718 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001719 }
1720 }
1721 }
1722
Dave Houlton6f9059e2017-05-02 17:15:13 -06001723 // Checks that apply only to compressed images
1724 if (FormatIsCompressed(dst_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001725 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001726
1727 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001728 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1729 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1730 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001731 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001732 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00144, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001733 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
1734 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001735 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001736 validation_error_map[VALIDATION_ERROR_09c00144]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001737 }
1738
Dave Houlton94a00372017-12-14 15:08:47 -07001739 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001740 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1741 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001742 skip |=
1743 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1744 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00146, "IMAGE",
1745 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
1746 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d). %s.",
1747 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width,
1748 validation_error_map[VALIDATION_ERROR_09c00146]);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001749 }
1750
Dave Houltonee281a52017-12-08 13:51:02 -07001751 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1752 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1753 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001754 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1755 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00148, "IMAGE",
1756 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1757 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
1758 "height (%d). %s.",
1759 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height,
1760 validation_error_map[VALIDATION_ERROR_09c00148]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001761 }
1762
Dave Houltonee281a52017-12-08 13:51:02 -07001763 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1764 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1765 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001766 skip |=
1767 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1768 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0014a, "IMAGE",
1769 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
1770 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d). %s.",
1771 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth,
1772 validation_error_map[VALIDATION_ERROR_09c0014a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001773 }
1774 } // Compressed
1775 }
1776 return skip;
1777}
1778
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001779bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001780 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1781 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001782 bool skip = false;
1783 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001784 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1785
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001786 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1787
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001788 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001789 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001790
1791 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1792 VkExtent3D src_copy_extent = region.extent;
1793 VkExtent3D dst_copy_extent =
1794 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1795
Dave Houlton6f9059e2017-05-02 17:15:13 -06001796 bool slice_override = false;
1797 uint32_t depth_slices = 0;
1798
1799 // Special case for copying between a 1D/2D array and a 3D image
1800 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1801 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1802 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001803 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001804 slice_override = (depth_slices != 1);
1805 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1806 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001807 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001808 slice_override = (depth_slices != 1);
1809 }
1810
Dave Houltonee281a52017-12-08 13:51:02 -07001811 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001812 std::stringstream ss;
1813 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001814 skip |=
1815 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1816 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001817 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001818
Dave Houltonee281a52017-12-08 13:51:02 -07001819 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001820 std::stringstream ss;
1821 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001822 skip |=
1823 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1824 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001825 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001826
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001827 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001828 // No chance of mismatch if we're overriding depth slice count
1829 if (!slice_override) {
1830 // The number of depth slices in srcSubresource and dstSubresource must match
1831 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1832 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001833 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1834 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001835 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001836 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1837 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001838 if (src_slices != dst_slices) {
1839 std::stringstream ss;
1840 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1841 << "] do not match";
1842 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001843 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1844 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001845 }
1846 }
1847 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001848 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001849 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001850 std::stringstream ss;
1851 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1852 << "] do not match";
1853 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001854 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1855 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001856 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001857 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001858
Dave Houltonf5217612018-02-02 16:18:52 -07001859 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1860 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
1861 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1862 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1863 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1864 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00112, "IMAGE", "%s. %s", str,
1865 validation_error_map[VALIDATION_ERROR_09c00112]);
1866 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001867 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001868
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001869 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001870 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001871 std::stringstream ss;
1872 ss << "vkCmdCopyImage: pRegion[" << i
1873 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1874 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001875 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011c, "IMAGE", "%s. %s",
1876 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011c]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001877 }
1878
1879 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001880 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001881 std::stringstream ss;
1882 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1883 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001884 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011e, "IMAGE", "%s. %s",
1885 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011e]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001886 }
1887
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001888 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001889 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1890 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001891 std::stringstream ss;
1892 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1893 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001894 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600150, "IMAGE", "%s. %s",
1895 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600150]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001896 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001897
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001898 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1899 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001900 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1901 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001902 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1903 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001904 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a60014e, "IMAGE", "%s. %s", str,
1905 validation_error_map[VALIDATION_ERROR_0a60014e]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001906 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001907
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001908 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001909 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001910 std::stringstream ss;
1911 ss << "vkCmdCopyImage: pRegions[" << i
1912 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1913 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07001914 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d40, "IMAGE", "%s. %s",
1915 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_19000d40]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001916 }
Dave Houltonee281a52017-12-08 13:51:02 -07001917 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001918 std::stringstream ss;
1919 ss << "vkCmdCopyImage: pRegions[" << i
1920 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1921 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07001922 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d42, "IMAGE", "%s. %s",
1923 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_19000d42]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001924 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001925
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001926 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1927 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001928 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001929 std::stringstream ss;
1930 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001931 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001932 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07001933 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d44, "IMAGE", "%s. %s",
1934 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_19000d44]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001935 }
Dave Houltonee281a52017-12-08 13:51:02 -07001936 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001937 std::stringstream ss;
1938 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001939 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001940 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07001941 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d46, "IMAGE", "%s. %s",
1942 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_19000d46]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001943 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001944
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001945 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1946 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1947 // 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 -07001948 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1949 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001950 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001951 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1952 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1953 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1954 << " ] exceeds the source image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001955 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001956 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f4, "IMAGE", "%s. %s",
1957 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f4]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001958 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001959
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001960 // 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 -07001961 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1962 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001963 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001964 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
1965 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
1966 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
1967 << " ] exceeds the destination image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001968 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001969 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f6, "IMAGE", "%s. %s",
1970 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f6]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001971 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001972 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001973
Dave Houltonfc1a4052017-04-27 14:32:45 -06001974 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07001975 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1976 if (slice_override) src_copy_extent.depth = depth_slices;
1977 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001978 if (extent_check & x_bit) {
1979 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001980 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00120, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001981 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1982 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001983 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001984 validation_error_map[VALIDATION_ERROR_09c00120]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001985 }
1986
1987 if (extent_check & y_bit) {
1988 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001989 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00122, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001990 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1991 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001992 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001993 validation_error_map[VALIDATION_ERROR_09c00122]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001994 }
1995 if (extent_check & z_bit) {
1996 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001997 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00126, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001998 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1999 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07002000 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002001 validation_error_map[VALIDATION_ERROR_09c00126]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002002 }
2003
Dave Houltonee281a52017-12-08 13:51:02 -07002004 // Adjust dest extent if necessary
2005 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2006 if (slice_override) dst_copy_extent.depth = depth_slices;
2007
2008 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002009 if (extent_check & x_bit) {
2010 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002011 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012c, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002012 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2013 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07002014 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002015 validation_error_map[VALIDATION_ERROR_09c0012c]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002016 }
2017 if (extent_check & y_bit) {
2018 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002019 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012e, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002020 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2021 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07002022 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002023 validation_error_map[VALIDATION_ERROR_09c0012e]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002024 }
2025 if (extent_check & z_bit) {
2026 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002027 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00132, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002028 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2029 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07002030 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002031 validation_error_map[VALIDATION_ERROR_09c00132]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002032 }
2033
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002034 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2035 // must not overlap in memory
2036 if (src_image_state->image == dst_image_state->image) {
2037 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002038 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2039 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002040 std::stringstream ss;
2041 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2042 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002043 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f8, "IMAGE", "%s. %s",
2044 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f8]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002045 }
2046 }
2047 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002048 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002049
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002050 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2051 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2052 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002053 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002054 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2055 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002056 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2057 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002058 }
2059 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002060 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2061 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002062 if (srcSize != destSize) {
2063 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2064 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002065 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_1900010e, "IMAGE", "%s. %s", str,
2066 validation_error_map[VALIDATION_ERROR_1900010e]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002067 }
2068 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002069
Dave Houlton33c22b72017-02-28 13:16:02 -07002070 // Source and dest image sample counts must match
2071 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2072 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2073 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002074 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000110, "IMAGE", "%s %s", str,
2075 validation_error_map[VALIDATION_ERROR_19000110]);
Dave Houlton33c22b72017-02-28 13:16:02 -07002076 }
2077
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002078 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2079 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002080 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002081 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002082 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002083 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002084 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002085 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002086 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002087 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002088 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002089 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002090 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002091 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002092 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002093 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002094 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002095 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2096 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002097 }
2098
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002099 return skip;
2100}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002101
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002102void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002103 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2104 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2105 // Make sure that all image slices are updated to correct layout
2106 for (uint32_t i = 0; i < region_count; ++i) {
2107 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2108 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2109 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002110 // Update bindings between images and cmd buffer
2111 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2112 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002113 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002114 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002115 function = [=]() {
2116 SetImageMemoryValid(device_data, dst_image_state, true);
2117 return false;
2118 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002119 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002120}
2121
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002122// Returns true if sub_rect is entirely contained within rect
2123static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2124 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2125 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2126 return false;
2127 return true;
2128}
2129
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002130bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2131 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002132 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002133 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2134
2135 bool skip = false;
2136 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002137 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2138 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002139 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002140 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002141 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002142 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2143 // 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 -07002144 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2145 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002146 skip |= log_msg(
2147 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2148 HandleToUint64(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
2149 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2150 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2151 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002152 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002153 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002154 }
2155
2156 // Validate that attachment is in reference list of active subpass
2157 if (cb_node->activeRenderPass) {
2158 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2159 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002160 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002161
2162 for (uint32_t i = 0; i < attachmentCount; i++) {
2163 auto clear_desc = &pAttachments[i];
2164 VkImageView image_view = VK_NULL_HANDLE;
2165
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002166 if (0 == clear_desc->aspectMask) {
2167 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002168 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c03, "IMAGE", "%s",
2169 validation_error_map[VALIDATION_ERROR_01c00c03]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002170 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2171 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002172 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00028, "IMAGE", "%s",
2173 validation_error_map[VALIDATION_ERROR_01c00028]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002174 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002175 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002176 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2177 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_1860001e, "DS",
2178 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
2179 clear_desc->colorAttachment, cb_node->activeSubpass,
2180 validation_error_map[VALIDATION_ERROR_1860001e]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002181 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2182 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002183 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer), __LINE__,
2184 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002185 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2186 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002187 } else {
2188 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002189 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002190 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002191 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2192 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2193 char const str[] =
Tobin Ehlisf9c50272018-03-12 08:19:33 -06002194 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002195 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002196 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00026, "IMAGE", str, i,
2197 validation_error_map[VALIDATION_ERROR_01c00026]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002198 }
2199 } else { // Must be depth and/or stencil
2200 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2201 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Tobin Ehlisf9c50272018-03-12 08:19:33 -06002202 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits. %s";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002203 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002204 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c01, "IMAGE", str, i,
2205 validation_error_map[VALIDATION_ERROR_01c00c01]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002206 }
2207 if (!subpass_desc->pDepthStencilAttachment ||
2208 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2209 skip |= log_msg(
2210 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002211 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002212 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002213 } else {
2214 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2215 }
2216 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002217 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002218 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002219 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002220 // The rectangular region specified by a given element of pRects must be contained within the render area of
2221 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002222 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2223 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2224 skip |=
2225 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002226 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002227 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2228 "the current render pass instance. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002229 j, validation_error_map[VALIDATION_ERROR_18600020]);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002230 }
2231 } else {
2232 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2233 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2234 return log_msg(
2235 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2236 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
2237 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2238 "the current render pass instance. %s",
2239 j, validation_error_map[VALIDATION_ERROR_18600020]);
2240 }
2241 return false;
2242 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002243 }
2244 // The layers specified by a given element of pRects must be contained within every attachment that
2245 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002246 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002247 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2248 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002249 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2250 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600022, "DS",
2251 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2252 "of pAttachment[%d]. %s",
2253 j, i, validation_error_map[VALIDATION_ERROR_18600022]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002254 }
2255 }
2256 }
2257 }
2258 }
2259 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002260}
2261
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002262bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002263 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002264 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002265 bool skip = false;
2266 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002267 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2268 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2269 skip |=
2270 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002271 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002272 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002273
2274 // For each region, the number of layers in the image subresource should not be zero
2275 // For each region, src and dest image aspect must be color only
2276 for (uint32_t i = 0; i < regionCount; i++) {
2277 if (pRegions[i].srcSubresource.layerCount == 0) {
2278 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002279 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002280 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002281 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002282 if (pRegions[i].dstSubresource.layerCount == 0) {
2283 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002284 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002285 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002286 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002287 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2288 skip |= log_msg(
2289 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002290 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200216, "IMAGE",
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002291 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002292 validation_error_map[VALIDATION_ERROR_0a200216]);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002293 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002294 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2295 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2296 char const str[] =
2297 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2298 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002299 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200214, "IMAGE", "%s. %s", str,
2300 validation_error_map[VALIDATION_ERROR_0a200214]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002301 }
2302 }
2303
2304 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2305 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002306 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002307 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002308 }
2309 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2310 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002311 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002312 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002313 }
2314 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2315 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2316 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002317 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800202, "IMAGE", "%s. %s", str,
2318 validation_error_map[VALIDATION_ERROR_1c800202]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002319 }
2320 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2321 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2322 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002323 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800206, "IMAGE", "%s. %s", str,
2324 validation_error_map[VALIDATION_ERROR_1c800206]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002325 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002326 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002327 } else {
2328 assert(0);
2329 }
2330 return skip;
2331}
2332
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002333void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2334 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002335 // Update bindings between images and cmd buffer
2336 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2337 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2338
2339 std::function<bool()> function = [=]() {
2340 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2341 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002342 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002343 function = [=]() {
2344 SetImageMemoryValid(device_data, dst_image_state, true);
2345 return false;
2346 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002347 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002348}
2349
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002350bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002351 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2352 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002353 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2354
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002355 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002356 if (cb_node) {
2357 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2358 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002359 if (cb_node && src_image_state && dst_image_state) {
2360 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002361 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002362 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002363 VALIDATION_ERROR_184001d4);
2364 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2365 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2366 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2367 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2368 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2369 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2370 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002371 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002372 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002373 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002374
Dave Houlton33c2d252017-06-09 17:08:32 -06002375 VkFormat src_format = src_image_state->createInfo.format;
2376 VkFormat dst_format = dst_image_state->createInfo.format;
2377 VkImageType src_type = src_image_state->createInfo.imageType;
2378 VkImageType dst_type = dst_image_state->createInfo.imageType;
2379
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002380 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002381 VkImageTiling tiling = src_image_state->createInfo.tiling;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002382 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002383 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2384 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2385 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b4, "IMAGE",
2386 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature. %s",
2387 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001b4]);
2388 }
2389
2390 if ((VK_FILTER_LINEAR == filter) &&
2391 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
2392 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2393 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d6, "IMAGE",
2394 "vkCmdBlitImage: source image format %s does not support linear filtering. %s",
2395 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d6]);
2396 }
2397
2398 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2399 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
2400 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2401 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d8, "IMAGE",
2402 "vkCmdBlitImage: source image format %s does not support cubic filtering. %s",
2403 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d8]);
2404 }
2405
2406 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2407 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2408 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001da, "IMAGE",
2409 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified. %s",
2410 validation_error_map[VALIDATION_ERROR_184001da]);
2411 }
2412
2413 props = GetFormatProperties(device_data, dst_format);
2414 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002415 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002416 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
2417 skip |=
2418 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2419 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001be, "IMAGE",
2420 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature. %s",
2421 string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_184001be]);
2422 }
2423
2424 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2425 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2426 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2427 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001c8, "IMAGE",
2428 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT. %s",
2429 validation_error_map[VALIDATION_ERROR_184001c8]);
2430 }
2431
2432 // Validate consistency for unsigned formats
2433 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2434 std::stringstream ss;
2435 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2436 << "the other one must also have unsigned integer format. "
2437 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2438 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2439 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001cc, "IMAGE", "%s. %s",
2440 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001cc]);
2441 }
2442
2443 // Validate consistency for signed formats
2444 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2445 std::stringstream ss;
2446 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2447 << "the other one must also have signed integer format. "
2448 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2449 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2450 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ca, "IMAGE", "%s. %s",
2451 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ca]);
2452 }
2453
2454 // Validate filter for Depth/Stencil formats
2455 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2456 std::stringstream ss;
2457 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2458 << "then filter must be VK_FILTER_NEAREST.";
2459 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2460 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d0, "IMAGE", "%s. %s",
2461 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001d0]);
2462 }
2463
2464 // Validate aspect bits and formats for depth/stencil images
2465 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2466 if (src_format != dst_format) {
2467 std::stringstream ss;
2468 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2469 << "stencil, the other one must have exactly the same format. "
2470 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2471 << string_VkFormat(dst_format);
2472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2473 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ce, "IMAGE", "%s. %s",
2474 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ce]);
2475 }
2476
2477#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2478 for (uint32_t i = 0; i < regionCount; i++) {
2479 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2480
2481 if (FormatIsDepthAndStencil(src_format)) {
2482 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2483 std::stringstream ss;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002484 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of VK_IMAGE_ASPECT_DEPTH_BIT "
Dave Houlton33c2d252017-06-09 17:08:32 -06002485 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2486 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2487 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2488 "%s", ss.str().c_str());
2489 }
2490 }
2491 else if (FormatIsStencilOnly(src_format)) {
2492 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2493 std::stringstream ss;
2494 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2495 << "set in both the srcImage and dstImage";
2496 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2497 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2498 "%s", ss.str().c_str());
2499 }
2500 }
2501 else if (FormatIsDepthOnly(src_format)) {
2502 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2503 std::stringstream ss;
2504 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2505 << "set in both the srcImage and dstImage";
2506 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2507 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2508 "%s", ss.str().c_str());
2509 }
2510 }
2511 }
2512#endif
2513 } // Depth or Stencil
2514
2515 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002516 for (uint32_t i = 0; i < region_count; i++) {
2517 const VkImageBlit rgn = regions[i];
2518 bool hit_error = false;
2519 skip |=
2520 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2521 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2522 skip |=
2523 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2524 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002525
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002526 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002527 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2528 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002529 std::stringstream ss;
2530 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2531 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002532 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2533 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002534 }
Dave Houlton48989f32017-05-26 15:01:46 -06002535 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2536 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002537 std::stringstream ss;
2538 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2539 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002540 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2541 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002542 }
Dave Houlton48989f32017-05-26 15:01:46 -06002543 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002544 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2545 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002546 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002547 }
Dave Houlton48989f32017-05-26 15:01:46 -06002548 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002549 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2550 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002551 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002552 }
2553
2554 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002555 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002556 skip |=
2557 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002558 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001de, "IMAGE",
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002559 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002560 i, validation_error_map[VALIDATION_ERROR_09a001de]);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002561 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002562
Dave Houlton48989f32017-05-26 15:01:46 -06002563 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002564 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002565 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001dc, "IMAGE",
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002566 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002567 validation_error_map[VALIDATION_ERROR_09a001dc]);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002568 }
Dave Houlton48989f32017-05-26 15:01:46 -06002569
Dave Houlton33c2d252017-06-09 17:08:32 -06002570 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2571 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2572 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e2, "IMAGE",
2573 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
2574 "image format %s. %s",
2575 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format),
2576 validation_error_map[VALIDATION_ERROR_09a001e2]);
2577 }
2578
2579 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2580 skip |= log_msg(
2581 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2582 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e4, "IMAGE",
2583 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s. %s",
2584 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_09a001e4]);
2585 }
2586
Dave Houlton48989f32017-05-26 15:01:46 -06002587 // Validate source image offsets
2588 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002589 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002590 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2591 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2592 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ea, "IMAGE",
2593 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
2594 "of (%1d, %1d). These must be (0, 1). %s",
2595 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001ea]);
2596 }
2597 }
2598
Dave Houlton33c2d252017-06-09 17:08:32 -06002599 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002600 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2601 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2602 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ee, "IMAGE",
2603 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2604 "srcOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2605 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001ee]);
2606 }
2607 }
2608
Dave Houlton33c2d252017-06-09 17:08:32 -06002609 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002610 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2611 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002612 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002613 skip |= log_msg(
2614 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2615 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e6, "IMAGE",
2616 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d). %s", i,
2617 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width, validation_error_map[VALIDATION_ERROR_09a001e6]);
2618 }
2619 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2620 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002621 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002622 skip |= log_msg(
2623 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2624 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e8, "IMAGE",
2625 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d). %s", i,
2626 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height, validation_error_map[VALIDATION_ERROR_09a001e8]);
2627 }
2628 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2629 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002630 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002631 skip |= log_msg(
2632 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2633 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ec, "IMAGE",
2634 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d). %s", i,
2635 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth, validation_error_map[VALIDATION_ERROR_09a001ec]);
2636 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002637 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2638 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2639 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2640 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d. %s", i,
2641 rgn.srcSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001ae]);
2642 } else if (oob) {
2643 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2644 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2645 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions. %s", i,
2646 validation_error_map[VALIDATION_ERROR_184001ae]);
2647 }
Dave Houlton48989f32017-05-26 15:01:46 -06002648
2649 // Validate dest image offsets
2650 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002651 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002652 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2653 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2654 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f4, "IMAGE",
2655 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
2656 "(%1d, %1d). These must be (0, 1). %s",
2657 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001f4]);
2658 }
2659 }
2660
Dave Houlton33c2d252017-06-09 17:08:32 -06002661 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002662 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2663 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2664 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f8, "IMAGE",
2665 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2666 "dstOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2667 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001f8]);
2668 }
2669 }
2670
Dave Houlton33c2d252017-06-09 17:08:32 -06002671 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002672 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2673 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002674 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002675 skip |= log_msg(
2676 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2677 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f0, "IMAGE",
2678 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d). %s", i,
2679 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width, validation_error_map[VALIDATION_ERROR_09a001f0]);
2680 }
2681 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2682 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002683 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002684 skip |= log_msg(
2685 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2686 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f2, "IMAGE",
2687 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d). %s", i,
2688 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height, validation_error_map[VALIDATION_ERROR_09a001f2]);
2689 }
2690 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2691 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002692 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002693 skip |= log_msg(
2694 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2695 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f6, "IMAGE",
2696 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d). %s", i,
2697 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth, validation_error_map[VALIDATION_ERROR_09a001f6]);
2698 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002699 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002700 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002701 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2702 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d. %s",
2703 i, rgn.dstSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001b0]);
2704 } else if (oob) {
2705 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2706 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2707 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions. %s", i,
2708 validation_error_map[VALIDATION_ERROR_184001b0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002709 }
2710
Dave Houlton33c2d252017-06-09 17:08:32 -06002711 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2712 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2713 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2714 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2715 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e0, "IMAGE",
2716 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
2717 "layerCount other than 1. %s",
2718 i, validation_error_map[VALIDATION_ERROR_09a001e0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002719 }
2720 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002721 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002722 } else {
2723 assert(0);
2724 }
2725 return skip;
2726}
2727
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002728void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002729 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2730 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2731 // Make sure that all image slices are updated to correct layout
2732 for (uint32_t i = 0; i < region_count; ++i) {
2733 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2734 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2735 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002736 // Update bindings between images and cmd buffer
2737 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2738 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2739
2740 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002741 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002742 function = [=]() {
2743 SetImageMemoryValid(device_data, dst_image_state, true);
2744 return false;
2745 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002746 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002747}
2748
Tony Barbourdf013b92017-01-25 12:53:48 -07002749// This validates that the initial layout specified in the command buffer for
2750// the IMAGE is the same
2751// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002752bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002753 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2754 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002755 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002756 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002757 for (auto cb_image_data : pCB->imageLayoutMap) {
2758 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002759
Dave Houltonb3f4b282018-02-22 16:25:16 -07002760 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2761 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002762 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2763 // TODO: Set memory invalid which is in mem_tracker currently
2764 } else if (imageLayout != cb_image_data.second.initialLayout) {
2765 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002766 skip |= log_msg(
2767 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2768 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2769 "Cannot submit cmd buffer using image (0x%" PRIx64
2770 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2771 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2772 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2773 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002774 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002775 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2776 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002777 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002778 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2779 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002780 }
2781 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002782 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002783 }
2784 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002785 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002786}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002787
Tony Barbourdf013b92017-01-25 12:53:48 -07002788void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2789 for (auto cb_image_data : pCB->imageLayoutMap) {
2790 VkImageLayout imageLayout;
2791 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2792 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2793 }
2794}
2795
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002796// Print readable FlagBits in FlagMask
2797static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2798 std::string result;
2799 std::string separator;
2800
2801 if (accessMask == 0) {
2802 result = "[None]";
2803 } else {
2804 result = "[";
2805 for (auto i = 0; i < 32; i++) {
2806 if (accessMask & (1 << i)) {
2807 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2808 separator = " | ";
2809 }
2810 }
2811 result = result + "]";
2812 }
2813 return result;
2814}
2815
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002816// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2817// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002818// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002819static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2820 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2821 const char *type) {
2822 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2823 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002824
2825 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2826 if (accessMask & ~(required_bit | optional_bits)) {
2827 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002828 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002829 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002830 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2831 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002832 }
2833 } else {
2834 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002835 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002836 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002837 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
2838 "has previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002839 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2840 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002841 } else {
2842 std::string opt_bits;
2843 if (optional_bits != 0) {
2844 std::stringstream ss;
2845 ss << optional_bits;
2846 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2847 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002848 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002849 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002850 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
2851 "previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002852 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2853 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002854 }
2855 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002856 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002857}
2858
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002859// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002860// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2861// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002862bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002863 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2864 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002865 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2866 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2867 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2868 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskieb9e73f2017-04-13 10:06:48 -06002869 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002870 VALIDATION_ERROR_12200688, "DS", "Cannot clear attachment %d with invalid first layout %s. %s",
2871 attachment, string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_12200688]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002872 }
2873 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002874 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002875}
2876
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002877bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2878 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002879 bool skip = false;
2880
Jason Ekstranda1906302017-12-03 20:16:32 -08002881 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2882 VkFormat format = pCreateInfo->pAttachments[i].format;
2883 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2884 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2885 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Tobin Ehlis73836462018-02-13 09:35:47 -07002886 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2887 DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002888 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
2889 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2890 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2891 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002892 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07002893 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Tobin Ehlis73836462018-02-13 09:35:47 -07002894 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2895 DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002896 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
2897 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2898 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2899 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002900 }
2901 }
2902 }
2903
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002904 // Track when we're observing the first use of an attachment
2905 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2906 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2907 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002908
2909 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2910 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2911 auto attach_index = subpass.pInputAttachments[j].attachment;
2912 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2913
2914 switch (subpass.pInputAttachments[j].layout) {
2915 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2916 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2917 // These are ideal.
2918 break;
2919
2920 case VK_IMAGE_LAYOUT_GENERAL:
2921 // May not be optimal. TODO: reconsider this warning based on other constraints.
2922 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2923 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2924 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2925 break;
2926
2927 default:
2928 // No other layouts are acceptable
2929 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2930 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2931 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2932 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2933 }
2934
2935 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2936 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2937 subpass.pDepthStencilAttachment->attachment == attach_index &&
2938 subpass.pDepthStencilAttachment->layout != layout;
2939 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2940 found_layout_mismatch =
2941 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2942 }
2943 if (found_layout_mismatch) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002944 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2945 VALIDATION_ERROR_140006ae, "DS",
2946 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a "
2947 "depth/color attachment with a different layout. %s",
2948 i, j, attach_index, layout, validation_error_map[VALIDATION_ERROR_140006ae]);
Cort Stratton7547f772017-05-04 15:18:52 -07002949 }
2950
2951 if (attach_first_use[attach_index]) {
2952 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2953 pCreateInfo->pAttachments[attach_index]);
2954
2955 bool used_as_depth =
2956 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2957 bool used_as_color = false;
2958 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2959 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2960 }
2961 if (!used_as_depth && !used_as_color &&
2962 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2963 skip |= log_msg(
2964 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002965 VALIDATION_ERROR_1400069c, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002966 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002967 attach_index, attach_index, validation_error_map[VALIDATION_ERROR_1400069c]);
Cort Stratton7547f772017-05-04 15:18:52 -07002968 }
2969 }
2970 attach_first_use[attach_index] = false;
2971 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002972 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2973 auto attach_index = subpass.pColorAttachments[j].attachment;
2974 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2975
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002976 // TODO: Need a way to validate shared presentable images here, currently just allowing
2977 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2978 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002979 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002980 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002981 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002982 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2983 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002984 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002985
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002986 case VK_IMAGE_LAYOUT_GENERAL:
2987 // May not be optimal; TODO: reconsider this warning based on other constraints?
2988 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2989 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2990 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2991 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002992
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002993 default:
2994 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2995 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2996 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2997 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002998 }
2999
3000 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003001 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
3002 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003003 }
3004 attach_first_use[attach_index] = false;
3005 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003006
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003007 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3008 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003009 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3010 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3011 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003012 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003013
Dave Houltona9df0ce2018-02-07 10:51:23 -07003014 case VK_IMAGE_LAYOUT_GENERAL:
3015 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3016 // doing a bunch of transitions.
3017 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
3018 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
3019 "GENERAL layout for depth attachment may not give optimal performance.");
3020 break;
3021
3022 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3023 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3024 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3025 break;
3026 } else {
3027 // Intentionally fall through to generic error message
3028 }
3029
3030 default:
3031 // No other layouts are acceptable
3032 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3033 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
3034 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3035 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3036 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003037 }
3038
3039 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3040 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003041 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
3042 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003043 }
3044 attach_first_use[attach_index] = false;
3045 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003046 }
3047 return skip;
3048}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003049
3050// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003051bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3052 VkDeviceSize offset, VkDeviceSize end_offset) {
3053 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3054 bool skip = false;
3055 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3056 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003057 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3058 for (auto image_handle : mem_info->bound_images) {
3059 auto img_it = mem_info->bound_ranges.find(image_handle);
3060 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003061 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003062 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003063 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003064 for (auto layout : layouts) {
3065 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003066 skip |=
3067 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
3068 HandleToUint64(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003069 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3070 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003071 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003072 }
3073 }
3074 }
3075 }
3076 }
3077 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003078 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003079}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003080
3081// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3082// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003083static 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 -06003084 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003085 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003086
3087 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003088 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003089 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003090 if (strict) {
3091 correct_usage = ((actual & desired) == desired);
3092 } else {
3093 correct_usage = ((actual & desired) != 0);
3094 }
3095 if (!correct_usage) {
3096 if (msgCode == -1) {
3097 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003098 skip =
3099 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__,
3100 MEMTRACK_INVALID_USAGE_FLAG, "MEM",
3101 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3102 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003103 } else {
3104 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Dave Houltona9df0ce2018-02-07 10:51:23 -07003105 skip = log_msg(
3106 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__, msgCode, "MEM",
3107 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation. %s",
3108 type_str, obj_handle, func_name, type_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003109 }
3110 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003111 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003112}
3113
3114// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3115// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003116bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003117 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003118 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3119 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003120}
3121
3122// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3123// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003124bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003125 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003126 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3127 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003128}
3129
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003130bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003131 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003132 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3133
Chris Forbese0f511c2017-06-14 12:38:01 -07003134 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003135
3136 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
3137 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003138 VALIDATION_ERROR_01400726, "DS",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003139 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
3140 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003141 validation_error_map[VALIDATION_ERROR_01400726]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003142 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003143
3144 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003145 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3146 VALIDATION_ERROR_01400728, "DS",
3147 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
3148 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set. %s",
3149 validation_error_map[VALIDATION_ERROR_01400728]);
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003150 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003151
3152 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003153 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3154 VALIDATION_ERROR_0140072a, "DS",
3155 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
3156 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set. %s",
3157 validation_error_map[VALIDATION_ERROR_0140072a]);
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003158 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003159 return skip;
3160}
3161
3162void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3163 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3164 GetBufferMap(device_data)
3165 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3166}
3167
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003168bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3169 bool skip = false;
3170 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003171 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3172 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003173 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003174 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3175 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003176 skip |= ValidateBufferUsageFlags(
3177 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 -06003178 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003179 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003180 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003181}
3182
3183void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3184 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3185}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003186
3187// For the given format verify that the aspect masks make sense
3188bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3189 const char *func_name) {
3190 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3191 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003192 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003193 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003194 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003195 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003196 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003197 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003198 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003199 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003200 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003201 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003202 validation_error_map[VALIDATION_ERROR_0a400c01]);
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,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003207 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
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 "
3209 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003210 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
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,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003213 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003214 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
3215 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003216 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
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,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003221 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003222 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003223 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003224 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003225 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003226 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003227 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003228 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003229 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003230 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003231 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003232 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003233 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003234 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003235 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003236 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003237 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003238 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003239 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003240 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003241 }
3242 }
3243 return skip;
3244}
3245
Petr Krausffa94af2017-08-08 21:46:02 +02003246struct SubresourceRangeErrorCodes {
3247 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3248};
3249
3250bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3251 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3252 const char *image_layer_count_var_name, const uint64_t image_handle,
3253 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003254 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3255 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003256
3257 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003258 if (subresourceRange.baseMipLevel >= image_mip_count) {
3259 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3260 errorCodes.base_mip_err, "IMAGE",
3261 "%s: %s.baseMipLevel (= %" PRIu32
3262 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 "). %s",
3263 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count,
3264 validation_error_map[errorCodes.base_mip_err]);
3265 }
Petr Kraus4d718682017-05-18 03:38:41 +02003266
Petr Krausffa94af2017-08-08 21:46:02 +02003267 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3268 if (subresourceRange.levelCount == 0) {
3269 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3270 __LINE__, errorCodes.mip_count_err, "IMAGE", "%s: %s.levelCount is 0. %s", cmd_name, param_name,
3271 validation_error_map[errorCodes.mip_count_err]);
3272 } else {
3273 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003274
Petr Krausffa94af2017-08-08 21:46:02 +02003275 if (necessary_mip_count > image_mip_count) {
3276 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3277 __LINE__, errorCodes.mip_count_err, "IMAGE",
3278 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3279 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 "). %s",
3280 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
3281 necessary_mip_count, image_mip_count, validation_error_map[errorCodes.mip_count_err]);
3282 }
Petr Kraus4d718682017-05-18 03:38:41 +02003283 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003284 }
Petr Kraus4d718682017-05-18 03:38:41 +02003285
3286 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003287 if (subresourceRange.baseArrayLayer >= image_layer_count) {
3288 skip |=
3289 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3290 errorCodes.base_layer_err, "IMAGE",
3291 "%s: %s.baseArrayLayer (= %" PRIu32
3292 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 "). %s",
3293 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count,
3294 validation_error_map[errorCodes.base_layer_err]);
3295 }
Petr Kraus4d718682017-05-18 03:38:41 +02003296
Petr Krausffa94af2017-08-08 21:46:02 +02003297 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3298 if (subresourceRange.layerCount == 0) {
3299 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3300 __LINE__, errorCodes.layer_count_err, "IMAGE", "%s: %s.layerCount is 0. %s", cmd_name, param_name,
3301 validation_error_map[errorCodes.layer_count_err]);
3302 } else {
3303 const uint64_t necessary_layer_count =
3304 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003305
Petr Krausffa94af2017-08-08 21:46:02 +02003306 if (necessary_layer_count > image_layer_count) {
3307 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3308 __LINE__, errorCodes.layer_count_err, "IMAGE",
3309 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3310 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 "). %s",
3311 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
3312 necessary_layer_count, image_layer_count_var_name, image_layer_count,
3313 validation_error_map[errorCodes.layer_count_err]);
3314 }
Petr Kraus4d718682017-05-18 03:38:41 +02003315 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003316 }
Petr Kraus4d718682017-05-18 03:38:41 +02003317
Mark Lobodzinski602de982017-02-09 11:01:33 -07003318 return skip;
3319}
3320
Petr Krausffa94af2017-08-08 21:46:02 +02003321bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3322 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3323 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3324 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3325 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3326 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3327
3328 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3329 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3330
3331 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3332 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003333 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00d6c;
Petr Krausffa94af2017-08-08 21:46:02 +02003334 subresourceRangeErrorCodes.base_layer_err =
3335 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3336 subresourceRangeErrorCodes.layer_count_err =
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003337 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00d6e;
Petr Krausffa94af2017-08-08 21:46:02 +02003338
3339 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3340 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3341 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3342}
3343
3344bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3345 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3346 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3347 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003348 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800d38;
Petr Krausffa94af2017-08-08 21:46:02 +02003349 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003350 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800d3a;
Petr Krausffa94af2017-08-08 21:46:02 +02003351
3352 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3353 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3354 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3355}
3356
3357bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3358 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3359 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3360 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003361 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00d3c;
Petr Krausffa94af2017-08-08 21:46:02 +02003362 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003363 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00d3e;
Petr Krausffa94af2017-08-08 21:46:02 +02003364
3365 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3366 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3367 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3368}
3369
3370bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3371 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3372 const char *param_name) {
3373 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3374 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003375 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000d78;
Petr Krausffa94af2017-08-08 21:46:02 +02003376 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003377 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000d7a;
Petr Krausffa94af2017-08-08 21:46:02 +02003378
3379 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3380 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3381 subresourceRangeErrorCodes);
3382}
3383
Mark Lobodzinski602de982017-02-09 11:01:33 -07003384bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3385 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3386 bool skip = false;
3387 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3388 if (image_state) {
3389 skip |= ValidateImageUsageFlags(
3390 device_data, image_state,
3391 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houltona9df0ce2018-02-07 10:51:23 -07003392 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003393 false, -1, "vkCreateImageView()",
3394 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3395 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003396 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003397 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003398 skip |= ValidateCreateImageViewSubresourceRange(
3399 device_data, image_state,
3400 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3401 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003402
3403 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3404 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003405 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3406 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003407 VkFormat view_format = create_info->format;
3408 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003409 VkImageType image_type = image_state->createInfo.imageType;
3410 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003411
3412 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3413 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003414 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3415 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3416 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3417 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3418 std::stringstream ss;
3419 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3420 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3421 << ") format " << string_VkFormat(image_format)
3422 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3423 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3425 __LINE__, VALIDATION_ERROR_0ac007f4, "IMAGE", "%s %s", ss.str().c_str(),
3426 validation_error_map[VALIDATION_ERROR_0ac007f4]);
3427 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003428 }
3429 } else {
3430 // Format MUST be IDENTICAL to the format the image was created with
3431 if (image_format != view_format) {
3432 std::stringstream ss;
3433 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003434 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003435 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003436 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003437 VALIDATION_ERROR_0ac007f6, "IMAGE", "%s %s", ss.str().c_str(),
3438 validation_error_map[VALIDATION_ERROR_0ac007f6]);
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,
3449 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3450 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3451 string_VkImageViewType(view_type), string_VkImageType(image_type),
3452 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3453 }
3454 break;
3455 case VK_IMAGE_TYPE_2D:
3456 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3457 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3458 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3459 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3460 __LINE__, VALIDATION_ERROR_0ac007d6, "IMAGE",
3461 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3462 string_VkImageViewType(view_type), string_VkImageType(image_type),
3463 validation_error_map[VALIDATION_ERROR_0ac007d6]);
3464 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3465 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3466 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3467 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3468 string_VkImageViewType(view_type), string_VkImageType(image_type),
3469 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3470 }
3471 }
3472 break;
3473 case VK_IMAGE_TYPE_3D:
3474 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3475 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3476 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3477 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
3478 skip |= log_msg(
3479 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3480 __LINE__, VALIDATION_ERROR_0ac007da, "IMAGE",
3481 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3482 string_VkImageViewType(view_type), string_VkImageType(image_type),
3483 validation_error_map[VALIDATION_ERROR_0ac007da]);
3484 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3485 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003486 skip |=
3487 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3488 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3489 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3490 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
3491 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled. %s",
3492 string_VkImageViewType(view_type), string_VkImageType(image_type),
3493 validation_error_map[VALIDATION_ERROR_0ac007fa]);
Jeremy Kniager846ab732017-07-10 13:12:04 -06003494 }
3495 } else {
3496 skip |=
3497 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3498 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3499 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3500 string_VkImageViewType(view_type), string_VkImageType(image_type),
3501 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3502 }
3503 }
3504 } else {
3505 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3506 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3507 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3508 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3509 string_VkImageViewType(view_type), string_VkImageType(image_type),
3510 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3511 }
3512 }
3513 break;
3514 default:
3515 break;
3516 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003517
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003518 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003519 bool check_tiling_features = false;
3520 VkFormatFeatureFlags tiling_features = 0;
3521 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3522 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3523 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3524 };
3525 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3526 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3527 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3528 };
3529 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3530 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003531 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003532 error_codes = linear_error_codes;
3533 check_tiling_features = true;
3534 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003535 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003536 error_codes = optimal_error_codes;
3537 check_tiling_features = true;
3538 }
3539
3540 if (check_tiling_features) {
3541 if (tiling_features == 0) {
3542 skip |=
3543 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3544 error_codes[0], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003545 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003546 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[0]]);
3547 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
3548 skip |=
3549 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3550 error_codes[1], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003551 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3552 "VK_IMAGE_USAGE_SAMPLED_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003553 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[1]]);
3554 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
3555 skip |=
3556 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3557 error_codes[2], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003558 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3559 "VK_IMAGE_USAGE_STORAGE_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003560 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[2]]);
3561 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3562 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
3563 skip |=
3564 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3565 error_codes[3], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003566 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3567 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003568 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[3]]);
3569 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3570 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
3571 skip |=
3572 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3573 error_codes[4], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003574 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3575 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003576 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[4]]);
3577 }
3578 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003579 }
3580 return skip;
3581}
3582
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003583void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3584 auto image_view_map = GetImageViewMap(device_data);
3585 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3586
3587 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003588 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003589 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3590 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003591}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003592
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003593bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3594 BUFFER_STATE *dst_buffer_state) {
3595 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003596 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3597 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003598 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003599 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3600 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3601 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3602 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003603 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003604 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003605 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003606 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003607 return skip;
3608}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003609
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003610void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3611 BUFFER_STATE *dst_buffer_state) {
3612 // Update bindings between buffers and cmd buffer
3613 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3614 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3615
3616 std::function<bool()> function = [=]() {
3617 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3618 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003619 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003620 function = [=]() {
3621 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3622 return false;
3623 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003624 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003625}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003626
3627static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3628 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3629 bool skip = false;
3630 auto buffer_state = GetBufferState(device_data, buffer);
3631 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003632 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
Petr Kraus13c98a62017-12-09 00:22:39 +01003633 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS", "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
3634 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003635 } else {
3636 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003637 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003638 HandleToUint64(buffer), __LINE__, VALIDATION_ERROR_23c00734, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +01003639 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer. %s", HandleToUint64(buffer),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003640 validation_error_map[VALIDATION_ERROR_23c00734]);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003641 }
3642 }
3643 return skip;
3644}
3645
3646bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3647 VK_OBJECT *obj_struct) {
3648 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003649 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003650 if (GetDisables(device_data)->destroy_image_view) return false;
3651 bool skip = false;
3652 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003653 skip |=
3654 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003655 }
3656 return skip;
3657}
3658
3659void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3660 VK_OBJECT obj_struct) {
3661 // Any bound cmd buffers are now invalid
3662 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3663 (*GetImageViewMap(device_data)).erase(image_view);
3664}
3665
3666bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3667 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003668 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003669 if (GetDisables(device_data)->destroy_buffer) return false;
3670 bool skip = false;
3671 if (*buffer_state) {
3672 skip |= validateIdleBuffer(device_data, buffer);
3673 }
3674 return skip;
3675}
3676
3677void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3678 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3679 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3680 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3681 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003682 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003683 }
3684 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003685 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003686 GetBufferMap(device_data)->erase(buffer_state->buffer);
3687}
3688
3689bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3690 VK_OBJECT *obj_struct) {
3691 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003692 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003693 if (GetDisables(device_data)->destroy_buffer_view) return false;
3694 bool skip = false;
3695 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003696 skip |=
3697 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003698 }
3699 return skip;
3700}
3701
3702void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3703 VK_OBJECT obj_struct) {
3704 // Any bound cmd buffers are now invalid
3705 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3706 GetBufferViewMap(device_data)->erase(buffer_view);
3707}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003708
3709bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3710 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003711 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003712 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003713 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003714 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3715 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003716 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003717 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003718 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003719 return skip;
3720}
3721
3722void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3723 std::function<bool()> function = [=]() {
3724 SetBufferMemoryValid(device_data, buffer_state, true);
3725 return false;
3726 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003727 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003728 // Update bindings between buffer and cmd buffer
3729 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003730}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003731
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003732bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3733 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003734 bool skip = false;
3735
3736 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003737 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3738 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003739 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003740 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160018e, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003741 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
3742 "and 1, respectively. %s",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003743 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003744 validation_error_map[VALIDATION_ERROR_0160018e]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003745 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003746 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003747
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003748 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3749 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003750 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003751 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600192, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003752 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
3753 "must be 0 and 1, respectively. %s",
3754 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003755 validation_error_map[VALIDATION_ERROR_01600192]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003756 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003757 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003758
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003759 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3760 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
3761 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003762 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001aa, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003763 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
3764 "For 3D images these must be 0 and 1, respectively. %s",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003765 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003766 validation_error_map[VALIDATION_ERROR_016001aa]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003767 }
3768 }
3769
3770 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3771 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003772 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003773 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003774 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003775 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600182, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003776 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
3777 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003778 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01600182]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003779 }
3780
3781 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003782 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003783 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003784 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600184, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003785 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003786 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01600184]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003787 }
3788
3789 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3790 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
3791 skip |= log_msg(
3792 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003793 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600186, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003794 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
3795 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003796 validation_error_map[VALIDATION_ERROR_01600186]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003797 }
3798
3799 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3800 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3801 skip |= log_msg(
3802 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003803 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600188, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003804 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
3805 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003806 validation_error_map[VALIDATION_ERROR_01600188]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003807 }
3808
3809 // subresource aspectMask must have exactly 1 bit set
3810 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3811 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3812 if (aspect_mask_bits.count() != 1) {
3813 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003814 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a8, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003815 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003816 validation_error_map[VALIDATION_ERROR_016001a8]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003817 }
3818
3819 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003820 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003821 skip |= log_msg(
3822 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003823 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a6, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003824 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
3825 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003826 validation_error_map[VALIDATION_ERROR_016001a6]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003827 }
3828
3829 // Checks that apply only to compressed images
3830 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3831 // reserves a place for these compressed image checks. This block of code could move there once the image
3832 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003833 if (FormatIsCompressed(image_state->createInfo.format)) {
3834 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003835
3836 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003837 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003838 skip |= log_msg(
3839 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003840 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600196, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003841 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003842 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01600196]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003843 }
3844
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003845 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003846 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003847 skip |= log_msg(
3848 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3849 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600198, "IMAGE",
3850 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d). %s.",
3851 function, i, pRegions[i].bufferImageHeight, block_size.height, validation_error_map[VALIDATION_ERROR_01600198]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003852 }
3853
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003854 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003855 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3856 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3857 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003858 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003859 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019a, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003860 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3861 "width & height (%d, %d). %s.",
3862 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003863 block_size.height, validation_error_map[VALIDATION_ERROR_0160019a]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003864 }
3865
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003866 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003867 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3868 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003869 skip |= log_msg(
3870 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3871 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019c, "IMAGE",
3872 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3873 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
3874 function, i, pRegions[i].bufferOffset, block_size_in_bytes, validation_error_map[VALIDATION_ERROR_0160019c]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003875 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003876
3877 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003878 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003879 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003880 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3881 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003882 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019e, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003883 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
3884 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
3885 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003886 mip_extent.width, validation_error_map[VALIDATION_ERROR_0160019e]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003887 }
3888
3889 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003890 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003891 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3892 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003893 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a0, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003894 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
3895 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
3896 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003897 mip_extent.height, validation_error_map[VALIDATION_ERROR_016001a0]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003898 }
3899
3900 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003901 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003902 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3903 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003904 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a2, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003905 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
3906 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
3907 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003908 mip_extent.depth, validation_error_map[VALIDATION_ERROR_016001a2]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003909 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003910 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003911 }
3912
3913 return skip;
3914}
3915
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003916static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3917 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003918 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003919 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003920
3921 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003922 VkExtent3D extent = pRegions[i].imageExtent;
3923 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003924
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003925 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3926 {
3927 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3928 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
3929 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
3930 extent.height, extent.depth);
3931 }
3932
3933 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3934
3935 // 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 -06003936 if (FormatIsCompressed(image_info->format)) {
3937 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003938 if (image_extent.width % block_extent.width) {
3939 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3940 }
3941 if (image_extent.height % block_extent.height) {
3942 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3943 }
3944 if (image_extent.depth % block_extent.depth) {
3945 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3946 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003947 }
3948
Dave Houltonfc1a4052017-04-27 14:32:45 -06003949 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003950 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003951 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003952 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003953 }
3954 }
3955
3956 return skip;
3957}
3958
Chris Forbese8ba09a2017-06-01 17:39:02 -07003959static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003960 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3961 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003962 bool skip = false;
3963
3964 VkDeviceSize buffer_size = buff_state->createInfo.size;
3965
3966 for (uint32_t i = 0; i < regionCount; i++) {
3967 VkExtent3D copy_extent = pRegions[i].imageExtent;
3968
3969 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3970 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003971 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003972
Dave Houltonf3229d52017-02-21 15:59:08 -07003973 // Handle special buffer packing rules for specific depth/stencil formats
3974 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003975 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003976 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3977 switch (image_state->createInfo.format) {
3978 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003979 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003980 break;
3981 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003982 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003983 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003984 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003985 case VK_FORMAT_D24_UNORM_S8_UINT:
3986 unit_size = 4;
3987 break;
3988 default:
3989 break;
3990 }
3991 }
3992
Dave Houlton1d2022c2017-03-29 11:43:58 -06003993 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003994 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003995 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003996 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3997 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3998
3999 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4000 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4001 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004002 }
4003
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004004 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4005 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4006 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004007 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004008 } else {
4009 // Calculate buffer offset of final copied byte, + 1.
4010 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4011 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4012 max_buffer_offset *= unit_size; // convert to bytes
4013 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004014
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004015 if (buffer_size < max_buffer_offset) {
4016 skip |=
4017 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4018 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
4019 i, buffer_size, validation_error_map[msg_code]);
4020 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004021 }
4022 }
4023
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004024 return skip;
4025}
4026
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004027bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004028 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004029 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004030 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4031 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4032
4033 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004034 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004035
4036 // Command pool must support graphics, compute, or transfer operations
4037 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4038
4039 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4040 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4041 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004042 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_19202415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004043 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
4044 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004045 validation_error_map[VALIDATION_ERROR_19202415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004046 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004047 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004048 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004049 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004050 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004051
4052 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004053 VALIDATION_ERROR_19200178);
4054 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
4055 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004056
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004057 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004058 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004059 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004060 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4061 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
4062 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004063 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004064 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004065 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
4066 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
4067 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004068 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06004069 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004070 }
4071 return skip;
4072}
4073
4074void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004075 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4076 VkImageLayout src_image_layout) {
4077 // Make sure that all image slices are updated to correct layout
4078 for (uint32_t i = 0; i < region_count; ++i) {
4079 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4080 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004081 // Update bindings between buffer/image and cmd buffer
4082 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004083 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004084
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004085 std::function<bool()> function = [=]() {
4086 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
4087 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004088 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004089 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004090 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004091 return false;
4092 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004093 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004094}
4095
4096bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004097 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004098 const VkBufferImageCopy *pRegions, const char *func_name) {
4099 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4100 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4101
4102 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004103 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004104
4105 // Command pool must support graphics, compute, or transfer operations
4106 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4107 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4108 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4109 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004110 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_18e02415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004111 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
4112 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004113 validation_error_map[VALIDATION_ERROR_18e02415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004114 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004115 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004116 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004117 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004118 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004119 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004120 VALIDATION_ERROR_18e00166);
4121 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4122 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4123 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4124 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4125 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004126 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004127 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004128 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004129 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004130 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4131 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4132 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004133 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4134 "vkCmdCopyBufferToImage()");
4135 }
4136 return skip;
4137}
4138
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004139void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004140 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4141 VkImageLayout dst_image_layout) {
4142 // Make sure that all image slices are updated to correct layout
4143 for (uint32_t i = 0; i < region_count; ++i) {
4144 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4145 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004146 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004147 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004148 std::function<bool()> function = [=]() {
4149 SetImageMemoryValid(device_data, dst_image_state, true);
4150 return false;
4151 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004152 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004153 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004154 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004155}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004156
4157bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4158 const auto report_data = core_validation::GetReportData(device_data);
4159 bool skip = false;
4160 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4161
Dave Houlton1d960ff2018-01-19 12:17:05 -07004162 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004163 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4164 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4165 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004166 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004167 __LINE__, VALIDATION_ERROR_2a6007ca, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004168 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004169 validation_error_map[VALIDATION_ERROR_2a6007ca]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004170 }
4171
4172 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4173 if (!image_entry) {
4174 return skip;
4175 }
4176
Dave Houlton1d960ff2018-01-19 12:17:05 -07004177 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004178 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004179 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004180 __LINE__, VALIDATION_ERROR_2a6007c8, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004181 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004182 validation_error_map[VALIDATION_ERROR_2a6007c8]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004183 }
4184
Dave Houlton1d960ff2018-01-19 12:17:05 -07004185 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004186 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004187 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07004188 __LINE__, VALIDATION_ERROR_2a600d68, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004189 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07004190 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_2a600d68]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004191 }
4192
Dave Houlton1d960ff2018-01-19 12:17:05 -07004193 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004194 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004195 skip |=
4196 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07004197 __LINE__, VALIDATION_ERROR_2a600d6a, "IMAGE",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004198 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07004199 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_2a600d6a]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004200 }
4201
Dave Houlton1d960ff2018-01-19 12:17:05 -07004202 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004203 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004204 if (FormatIsMultiplane(img_format)) {
4205 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4206 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4207 if (FormatPlaneCount(img_format) > 2u) {
4208 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4209 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4210 }
4211 if (sub_aspect != (sub_aspect & allowed_flags)) {
4212 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4213 HandleToUint64(image), __LINE__, vuid, "IMAGE",
4214 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
4215 ") must be a single-plane specifier flag. %s",
4216 sub_aspect, validation_error_map[vuid]);
4217 }
4218 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004219 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004220 skip |= log_msg(
4221 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), __LINE__,
4222 VALIDATION_ERROR_0a400c01, "IMAGE",
4223 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
4224 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004225 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004226 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004227 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004228 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004229 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004230 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
4231 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004232 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004233 }
4234 }
4235 return skip;
4236}