blob: 3a3698033bae5a281600f67768f0a69deb0eca7f [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
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700575void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
576 const VkImageMemoryBarrier *pImgMemBarriers) {
577 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700578
579 for (uint32_t i = 0; i < memBarrierCount; ++i) {
580 auto mem_barrier = &pImgMemBarriers[i];
581 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700582
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600583 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
584 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
585 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
586
Dave Houltonb3f4b282018-02-22 16:25:16 -0700587 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
588 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
589 // for all (potential) layer sub_resources.
590 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
591 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
592 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
593 }
594
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600595 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700596 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600597 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700598 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
599 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
600 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
601 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
602 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700603 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
604 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
605 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
606 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
607 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700608 }
609 }
610 }
611}
612
Tobin Ehlisc8266452017-04-07 12:20:30 -0600613bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600614 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600615 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700616 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600617 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600618 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700619
620 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
621 uint32_t layer = i + subLayers.baseArrayLayer;
622 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
623 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600624 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
625 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600626 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600627 // TODO: Improve log message in the next pass
Petr Kraus13c98a62017-12-09 00:22:39 +0100628 skip |= log_msg(
629 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
630 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
631 "%s: Cannot use image 0x%" PRIx64 " with specific layout %s that doesn't match the actual current layout %s.",
632 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600633 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700634 }
635 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600636 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
637 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
638 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700639 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
640 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600641 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200642 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer), __LINE__,
643 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100644 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
645 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700646 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600647 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600648 if (image_state->shared_presentable) {
649 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
650 // TODO: Add unique error id when available.
651 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
652 __LINE__, msg_code, "DS",
653 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
654 string_VkImageLayout(optimal_layout));
655 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600656 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700657 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600658 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600659 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 +0200660 HandleToUint64(cb_node->commandBuffer), __LINE__, msg_code, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100661 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL. %s", caller,
662 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout),
663 validation_error_map[msg_code]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700664 }
665 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600666 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700667}
668
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700669void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
670 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700671 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700672 if (!renderPass) return;
673
674 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
675 if (framebuffer_state) {
676 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
677 auto image_view = framebuffer_state->createInfo.pAttachments[i];
678 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
679 }
680 }
681}
Dave Houltone19e20d2018-02-02 16:32:41 -0700682
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700683bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700684 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600685 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700686 const debug_report_data *report_data = core_validation::GetReportData(device_data);
687
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600688 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600689 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 -0600690 VALIDATION_ERROR_09e0075e, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
691 validation_error_map[VALIDATION_ERROR_09e0075e]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600692
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600693 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600694 }
695
Dave Houlton130c0212018-01-29 13:39:56 -0700696 bool optimal_tiling = (VK_IMAGE_TILING_OPTIMAL == pCreateInfo->tiling);
697 const char *tiling_string = string_VkImageTiling(pCreateInfo->tiling);
698 const char *format_string = string_VkFormat(pCreateInfo->format);
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600699 VkFormatProperties properties = GetFormatProperties(device_data, pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700700 VkFormatFeatureFlags features = (optimal_tiling ? properties.optimalTilingFeatures : properties.linearTilingFeatures);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600701
Dave Houlton130c0212018-01-29 13:39:56 -0700702 if (0 == features) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600703 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700704 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ac : VALIDATION_ERROR_09e007a2);
705 ss << "vkCreateImage format parameter " << format_string << " is an unsupported format";
706 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
707 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600708 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600709 }
710
Dave Houlton130c0212018-01-29 13:39:56 -0700711 if ((pCreateInfo->usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600712 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700713 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ae : VALIDATION_ERROR_09e007a4);
714 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_SAMPLED_BIT is not supported for format " << format_string << " with tiling "
715 << tiling_string;
716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
717 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
718 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600719
Dave Houlton130c0212018-01-29 13:39:56 -0700720 if ((pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
721 std::stringstream ss;
722 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b0 : VALIDATION_ERROR_09e007a6);
723 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_STORAGE_BIT is not supported for format " << format_string << " with tiling "
724 << tiling_string;
725 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
726 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600727 }
728
Lenny Komowb79f04a2017-09-18 17:07:00 -0600729 // TODO: Add checks for EXTENDED_USAGE images to validate images are compatible
730 // For EXTENDED_USAGE images, format can match any image COMPATIBLE with original image
731 if (!GetDeviceExtensions(device_data)->vk_khr_maintenance2 || !(pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR)) {
732 // Validate that format supports usage as color attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700733 if ((pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
734 (0 == (features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT))) {
735 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b2 : VALIDATION_ERROR_09e007a8);
736 std::stringstream ss;
737 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_COLOR_ATTACHMENT is not supported for format " << format_string
738 << " with tiling " << tiling_string;
739 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
740 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600741 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600742
Lenny Komowb79f04a2017-09-18 17:07:00 -0600743 // Validate that format supports usage as depth/stencil attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700744 if ((pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
745 (0 == (features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
746 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b4 : VALIDATION_ERROR_09e007aa);
747 std::stringstream ss;
748 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT is not supported for format " << format_string
749 << " with tiling " << tiling_string;
750 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
751 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
752 }
753 }
754
755 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
756 std::stringstream ss;
757 ss << "vkCreateImage: Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set";
758 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
759 VALIDATION_ERROR_09e0076a, "IMAGE", "%s. %s", ss.str().c_str(),
760 validation_error_map[VALIDATION_ERROR_09e0076a]);
761 }
762
763 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
764 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
765 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
766 if (VK_SUCCESS != err) {
767 std::stringstream ss;
768 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
769 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
770 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
771 VALIDATION_ERROR_09e00758, "IMAGE", "%s. %s", ss.str().c_str(),
772 validation_error_map[VALIDATION_ERROR_09e00758]);
773 return skip;
774 }
775
776 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
777 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
778 std::stringstream ss;
779 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
780 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
781 VALIDATION_ERROR_09e0076e, "IMAGE", "%s. %s", ss.str().c_str(),
782 validation_error_map[VALIDATION_ERROR_09e0076e]);
783 }
784
785 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
786 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
787 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
788 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600789 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700790 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600791 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 -0700792 VALIDATION_ERROR_09e00770, "IMAGE", "%s. %s", ss.str().c_str(),
793 validation_error_map[VALIDATION_ERROR_09e00770]);
Lenny Komowb79f04a2017-09-18 17:07:00 -0600794 }
Dave Houlton130c0212018-01-29 13:39:56 -0700795 } else {
796 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
797 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600798 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700799 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
800 "format "
801 << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600802 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 -0700803 VALIDATION_ERROR_09e00772, "IMAGE", "%s. %s", ss.str().c_str(),
804 validation_error_map[VALIDATION_ERROR_09e00772]);
Lenny Komowb79f04a2017-09-18 17:07:00 -0600805 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600806 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700807 }
808
Dave Houlton130c0212018-01-29 13:39:56 -0700809 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
810 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
811 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
812 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
813 std::stringstream ss;
814 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
815 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
816 VALIDATION_ERROR_09e00776, "IMAGE", "%s. %s", ss.str().c_str(),
817 validation_error_map[VALIDATION_ERROR_09e00776]);
818 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700819 }
820
Dave Houlton130c0212018-01-29 13:39:56 -0700821 // 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 -0700822 // 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 -0700823 // implementation shown. DJH
824 //
825 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
826 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
827 // device_limits->maxImageDimension3D)) {
828 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
829 std::stringstream ss;
830 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
831 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
832 VALIDATION_ERROR_09e0077e, "IMAGE", "%s. %s", ss.str().c_str(),
833 validation_error_map[VALIDATION_ERROR_09e0077e]);
834 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700835
Dave Houlton130c0212018-01-29 13:39:56 -0700836 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
837 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
838 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
839 std::stringstream ss;
840 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
841 "maxFramebufferWidth";
842 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
843 VALIDATION_ERROR_09e00788, "IMAGE", "%s. %s", ss.str().c_str(),
844 validation_error_map[VALIDATION_ERROR_09e00788]);
845 }
846
847 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
848 std::stringstream ss;
849 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
850 "maxFramebufferHeight";
851 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
852 VALIDATION_ERROR_09e0078a, "IMAGE", "%s. %s", ss.str().c_str(),
853 validation_error_map[VALIDATION_ERROR_09e0078a]);
854 }
855
856 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
857 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
858 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
859
860 // Round up to imageGranularity boundary
861 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
862 uint64_t ig_mask = imageGranularity - 1;
863 total_size = (total_size + ig_mask) & ~ig_mask;
864
865 if (total_size > format_limits.maxResourceSize) {
Petr Kraus131a4a92018-03-14 19:53:58 +0100866 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 -0600867 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
Dave Houltona9df0ce2018-02-07 10:51:23 -0700868 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
869 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -0700870 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700871 }
872
Dave Houlton130c0212018-01-29 13:39:56 -0700873 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600874 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 -0700875 VALIDATION_ERROR_09e00780, "Image",
876 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s",
877 pCreateInfo->arrayLayers, format_limits.maxArrayLayers, validation_error_map[VALIDATION_ERROR_09e00780]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700878 }
879
Dave Houlton130c0212018-01-29 13:39:56 -0700880 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600881 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 -0600882 VALIDATION_ERROR_09e0078e, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Dave Houlton130c0212018-01-29 13:39:56 -0700883 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600884 validation_error_map[VALIDATION_ERROR_09e0078e]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700885 }
886
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600887 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600888 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
889 DRAWSTATE_INVALID_FEATURE, "DS",
890 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
891 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600892 }
893
Lenny Komowb79f04a2017-09-18 17:07:00 -0600894 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
895 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
896 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
897 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
898 // TODO: Add Maintenance2 VUID
899 skip |=
900 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
901 VALIDATION_ERROR_UNDEFINED, "DS",
902 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
903 "format must be block, ETC or ASTC compressed, but is %s",
904 string_VkFormat(pCreateInfo->format));
905 }
906 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
907 // TODO: Add Maintenance2 VUID
908 skip |=
909 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
910 VALIDATION_ERROR_UNDEFINED, "DS",
911 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
912 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
913 }
914 }
915 }
916
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600917 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700918}
919
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700920void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700921 IMAGE_LAYOUT_NODE image_state;
922 image_state.layout = pCreateInfo->initialLayout;
923 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700924 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 -0700925 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700926 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
927 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700928}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700929
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700930bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700931 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700932 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200933 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700934 if (disabled->destroy_image) return false;
935 bool skip = false;
936 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600937 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
938 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700939 }
940 return skip;
941}
942
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700943void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700944 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
945 // Clean up memory mapping, bindings and range references for image
946 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700947 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700948 if (mem_info) {
949 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
950 }
951 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600952 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700953 // Remove image from imageMap
954 core_validation::GetImageMap(device_data)->erase(image);
955 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
956 core_validation::GetImageSubresourceMap(device_data);
957
958 const auto &sub_entry = imageSubresourceMap->find(image);
959 if (sub_entry != imageSubresourceMap->end()) {
960 for (const auto &pair : sub_entry->second) {
961 core_validation::GetImageLayoutMap(device_data)->erase(pair);
962 }
963 imageSubresourceMap->erase(sub_entry);
964 }
965}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700966
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700967bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700968 bool skip = false;
969 const debug_report_data *report_data = core_validation::GetReportData(device_data);
970
971 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
972 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
973 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 +0200974 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700975 }
976
Dave Houlton1d2022c2017-03-29 11:43:58 -0600977 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700978 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
979 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 -0600980 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
981 validation_error_map[VALIDATION_ERROR_1880000e]);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600982 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700983 char const str[] = "vkCmdClearColorImage called with compressed image.";
984 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 -0600985 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
986 validation_error_map[VALIDATION_ERROR_1880000e]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700987 }
988
989 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
990 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
991 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600992 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_18800004, "IMAGE", "%s. %s", str,
993 validation_error_map[VALIDATION_ERROR_18800004]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700994 }
995 return skip;
996}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700997
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600998uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
999 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1000 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001001 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001002 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001003 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001004 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001005}
1006
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001007uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1008 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1009 uint32_t array_layer_count = range->layerCount;
1010 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1011 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001012 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001013 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001014}
1015
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001016bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001017 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1018 bool skip = false;
1019 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1020
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001021 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1022 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001023
1024 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1025 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001026 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1027 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001028 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 +02001029 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001030 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1031 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001032 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001033 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001034 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001035 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 -06001036 HandleToUint64(image_state->image), __LINE__, 0, "DS",
1037 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1038 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001039
1040 } else {
1041 if (image_state->shared_presentable) {
1042 skip |= log_msg(
1043 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001044 HandleToUint64(image_state->image), __LINE__, 0, "DS",
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001045 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1046 string_VkImageLayout(dest_image_layout));
1047 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001048 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001049 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001050 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001051 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001052 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001053 } else {
1054 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1055 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001056 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 +02001057 HandleToUint64(image_state->image), __LINE__, error_code, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001058 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL. %s", func_name,
1059 string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001060 }
1061 }
1062
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001063 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1064 uint32_t level = level_index + range.baseMipLevel;
1065 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1066 uint32_t layer = layer_index + range.baseArrayLayer;
1067 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001068 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001069 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001070 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001071 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001072 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001073 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001074 } else {
1075 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1076 }
1077 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1078 __LINE__, error_code, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001079 "%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 -07001080 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
1081 validation_error_map[error_code]);
1082 }
1083 }
1084 }
1085 }
1086
1087 return skip;
1088}
1089
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001090void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1091 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001092 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1093 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1094 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001095
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001096 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1097 uint32_t level = level_index + range.baseMipLevel;
1098 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1099 uint32_t layer = layer_index + range.baseArrayLayer;
1100 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001101 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001102 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1103 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 -07001104 }
1105 }
1106 }
1107}
1108
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001109bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001110 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1111 bool skip = false;
1112 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001113 auto cb_node = GetCBNode(dev_data, commandBuffer);
1114 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001115 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001116 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001117 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001118 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001119 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001120 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001121 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001122 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001123 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001124 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001125 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001126 }
1127 }
1128 return skip;
1129}
1130
1131// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001132void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001133 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001134 auto cb_node = GetCBNode(dev_data, commandBuffer);
1135 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001136 if (cb_node && image_state) {
1137 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1138 std::function<bool()> function = [=]() {
1139 SetImageMemoryValid(dev_data, image_state, true);
1140 return false;
1141 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001142 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001143 for (uint32_t i = 0; i < rangeCount; ++i) {
1144 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1145 }
1146 }
1147}
1148
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001149bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1150 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001151 const VkImageSubresourceRange *pRanges) {
1152 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001153 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1154
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001155 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001156 auto cb_node = GetCBNode(device_data, commandBuffer);
1157 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001158 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001159 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001160 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001161 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001162 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001163 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001164 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001165 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001166 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001167 skip |=
1168 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001169 // Image aspect must be depth or stencil or both
1170 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1171 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1172 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001173 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1174 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001175 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 +02001176 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001177 }
1178 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001179 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001180 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001181 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1182 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a0001c, "IMAGE", "%s. %s", str,
1183 validation_error_map[VALIDATION_ERROR_18a0001c]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001184 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001185 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1186 char const str[] =
1187 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1188 "set.";
1189 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1190 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00012, "IMAGE", "%s. %s", str,
1191 validation_error_map[VALIDATION_ERROR_18a00012]);
1192 }
1193 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1194 VkImageTiling tiling = image_state->createInfo.tiling;
1195 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1196 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1197 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
1198 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1199 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00010, "IMAGE",
1200 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1201 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR. %s",
1202 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling),
1203 validation_error_map[VALIDATION_ERROR_18a00010]);
1204 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001205 }
1206 return skip;
1207}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001208
1209// Returns true if [x, xoffset] and [y, yoffset] overlap
1210static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1211 bool result = false;
1212 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1213 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1214
1215 if (intersection_max > intersection_min) {
1216 result = true;
1217 }
1218 return result;
1219}
1220
1221// Returns true if two VkImageCopy structures overlap
Dave Houltonf5217612018-02-02 16:18:52 -07001222static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001223 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001224
1225 if (is_multiplane && (src->srcSubresource.aspectMask != dst->dstSubresource.aspectMask)) {
1226 return result;
1227 }
1228
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001229 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1230 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1231 dst->dstSubresource.layerCount))) {
1232 result = true;
1233 switch (type) {
1234 case VK_IMAGE_TYPE_3D:
1235 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1236 // Intentionally fall through to 2D case
1237 case VK_IMAGE_TYPE_2D:
1238 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1239 // Intentionally fall through to 1D case
1240 case VK_IMAGE_TYPE_1D:
1241 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1242 break;
1243 default:
1244 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1245 assert(false);
1246 }
1247 }
1248 return result;
1249}
1250
Dave Houltonfc1a4052017-04-27 14:32:45 -06001251// Returns non-zero if offset and extent exceed image extents
1252static const uint32_t x_bit = 1;
1253static const uint32_t y_bit = 2;
1254static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001255static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001256 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001257 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001258 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1259 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001260 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001261 }
1262 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1263 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001264 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001265 }
1266 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1267 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001268 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001269 }
1270 return result;
1271}
1272
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001273// Test if two VkExtent3D structs are equivalent
1274static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1275 bool result = true;
1276 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1277 (extent->depth != other_extent->depth)) {
1278 result = false;
1279 }
1280 return result;
1281}
1282
Dave Houltonee281a52017-12-08 13:51:02 -07001283// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1284// Destination image texel extents must be adjusted by block size for the dest validation checks
1285VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1286 VkExtent3D adjusted_extent = extent;
1287 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1288 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1289 adjusted_extent.width /= block_size.width;
1290 adjusted_extent.height /= block_size.height;
1291 adjusted_extent.depth /= block_size.depth;
1292 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1293 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1294 adjusted_extent.width *= block_size.width;
1295 adjusted_extent.height *= block_size.height;
1296 adjusted_extent.depth *= block_size.depth;
1297 }
1298 return adjusted_extent;
1299}
1300
Dave Houlton6f9059e2017-05-02 17:15:13 -06001301// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001302static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1303 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001304
1305 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001306 if (mip >= img->createInfo.mipLevels) {
1307 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001308 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001309
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001310 // 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 -06001311 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001312 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1313 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1314 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001315
Dave Houlton6f9059e2017-05-02 17:15:13 -06001316 // Image arrays have an effective z extent that isn't diminished by mip level
1317 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001318 extent.depth = img->createInfo.arrayLayers;
1319 }
1320
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001321 return extent;
1322}
1323
1324// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001325static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001326 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1327}
1328
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001329// Test if the extent argument has any dimensions set to 0.
1330static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1331 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1332}
1333
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001334// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1335static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1336 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1337 VkExtent3D granularity = {0, 0, 0};
1338 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1339 if (pPool) {
1340 granularity =
1341 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001342 if (FormatIsCompressed(img->createInfo.format)) {
1343 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001344 granularity.width *= block_size.width;
1345 granularity.height *= block_size.height;
1346 }
1347 }
1348 return granularity;
1349}
1350
1351// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1352static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1353 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001354 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1355 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001356 valid = false;
1357 }
1358 return valid;
1359}
1360
1361// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1362static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1363 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1364 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1365 bool skip = false;
1366 VkExtent3D offset_extent = {};
1367 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1368 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1369 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001370 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001371 // 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 -07001372 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001373 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1374 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001375 "%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 "
1376 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001377 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001378 }
1379 } else {
1380 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1381 // integer multiples of the image transfer granularity.
1382 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001383 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1384 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001385 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1386 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001387 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1388 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001389 }
1390 }
1391 return skip;
1392}
1393
1394// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1395static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1396 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001397 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001398 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1399 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001400 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001401 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1402 // subresource extent.
1403 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001404 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1405 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1406 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1407 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1408 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1409 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001410 }
1411 } else {
1412 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1413 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1414 // subresource extent dimensions.
1415 VkExtent3D offset_extent_sum = {};
1416 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1417 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1418 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001419 bool x_ok = true;
1420 bool y_ok = true;
1421 bool z_ok = true;
1422 switch (image_type) {
1423 case VK_IMAGE_TYPE_3D:
1424 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1425 (subresource_extent->depth == offset_extent_sum.depth));
1426 // Intentionally fall through to 2D case
1427 case VK_IMAGE_TYPE_2D:
1428 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1429 (subresource_extent->height == offset_extent_sum.height));
1430 // Intentionally fall through to 1D case
1431 case VK_IMAGE_TYPE_1D:
1432 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1433 (subresource_extent->width == offset_extent_sum.width));
1434 break;
1435 default:
1436 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1437 assert(false);
1438 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001439 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001440 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1441 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1442 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1443 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1444 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1445 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1446 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1447 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001448 }
1449 }
1450 return skip;
1451}
1452
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001453// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001454bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1455 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1456 const uint32_t i, const char *function) {
1457 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001458 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001459 // TODO: Add granularity checking for compressed formats
1460
1461 // bufferRowLength must be a multiple of the compressed texel block width
1462 // bufferImageHeight must be a multiple of the compressed texel block height
1463 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1464 // bufferOffset must be a multiple of the compressed texel block size in bytes
1465 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1466 // must equal the image subresource width
1467 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1468 // must equal the image subresource height
1469 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1470 // must equal the image subresource depth
1471 } else {
1472 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001473 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1474 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1475 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001476 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001477 }
1478 return skip;
1479}
1480
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001481// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001482bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001483 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1484 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001485 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001486 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001487 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001488 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001489 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001490 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001491 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001492 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001493
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001494 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001495 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001496 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houltonee281a52017-12-08 13:51:02 -07001497 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001498 const VkExtent3D dest_effective_extent =
1499 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001500 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001501 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001502 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001503 return skip;
1504}
1505
Dave Houlton6f9059e2017-05-02 17:15:13 -06001506// Validate contents of a VkImageCopy struct
1507bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1508 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1509 bool skip = false;
1510
1511 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001512 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001513
1514 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001515 const VkExtent3D src_copy_extent = region.extent;
1516 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001517 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1518
Dave Houlton6f9059e2017-05-02 17:15:13 -06001519 bool slice_override = false;
1520 uint32_t depth_slices = 0;
1521
1522 // Special case for copying between a 1D/2D array and a 3D image
1523 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1524 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001525 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001526 slice_override = (depth_slices != 1);
1527 } 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 -07001528 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001529 slice_override = (depth_slices != 1);
1530 }
1531
1532 // Do all checks on source image
1533 //
1534 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001535 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1536 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1537 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00124, "IMAGE",
1538 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
1539 "be 0 and 1, respectively. %s",
1540 i, region.srcOffset.y, src_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00124]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001541 }
1542 }
1543
Dave Houlton533be9f2018-03-26 17:08:30 -06001544 // VUID-VkImageCopy-srcImage-01785
1545 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1546 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1547 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00df2, "IMAGE",
1548 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
1549 "these must be 0 and 1, respectively. %s",
1550 i, region.srcOffset.z, src_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00df2]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001551 }
1552
Dave Houlton533be9f2018-03-26 17:08:30 -06001553 // VUID-VkImageCopy-srcImage-01787
1554 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1555 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1556 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00df6, "IMAGE",
1557 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0. %s", i,
1558 region.srcOffset.z, validation_error_map[VALIDATION_ERROR_09c00df6]);
1559 }
1560
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001561 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001562 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001563 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001564 skip |=
1565 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001566 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001567 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
1568 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001569 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001570 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001571 }
1572 }
1573 } else { // Pre maint 1
1574 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001575 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001576 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1577 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1578 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1579 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
1580 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001581 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001582 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001583 }
1584 }
1585 }
1586
Dave Houlton6f9059e2017-05-02 17:15:13 -06001587 // Checks that apply only to compressed images
1588 if (FormatIsCompressed(src_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001589 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001590
1591 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001592 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1593 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1594 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001595 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 +01001596 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001597 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
1598 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001599 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001600 validation_error_map[VALIDATION_ERROR_09c0013a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001601 }
1602
Dave Houlton94a00372017-12-14 15:08:47 -07001603 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001604 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1605 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001606 skip |=
1607 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001608 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013c, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001609 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1610 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001611 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001612 validation_error_map[VALIDATION_ERROR_09c0013c]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001613 }
1614
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001615 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001616 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1617 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001618 skip |=
1619 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001620 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013e, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001621 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1622 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001623 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001624 validation_error_map[VALIDATION_ERROR_09c0013e]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001625 }
1626
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001627 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001628 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1629 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001630 skip |=
1631 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001632 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00140, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001633 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1634 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001635 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001636 validation_error_map[VALIDATION_ERROR_09c00140]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001637 }
1638 } // Compressed
1639
1640 // Do all checks on dest image
1641 //
1642 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001643 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001644 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1645 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00130, "IMAGE",
1646 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
1647 "these must be 0 and 1, respectively. %s",
1648 i, region.dstOffset.y, dst_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00130]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001649 }
1650 }
1651
Dave Houlton533be9f2018-03-26 17:08:30 -06001652 // VUID-VkImageCopy-dstImage-01786
1653 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
1654 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1655 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00df4, "IMAGE",
1656 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
1657 "and 1, respectively. %s",
1658 i, region.dstOffset.z, dst_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00df4]);
1659 }
1660
1661 // VUID-VkImageCopy-dstImage-01788
1662 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
1663 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1664 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00df8, "IMAGE",
1665 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0. %s", i,
1666 region.dstOffset.z, validation_error_map[VALIDATION_ERROR_09c00df8]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001667 }
1668
1669 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001670 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001671 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 +01001672 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001673 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1674 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001675 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001676 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001677 }
1678 }
1679 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001680 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001681 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001682 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001683 skip |=
1684 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001685 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001686 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1687 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001688 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001689 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001690 }
1691 }
1692 } else { // Pre maint 1
1693 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001694 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001695 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1696 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1697 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1698 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
1699 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001700 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001701 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001702 }
1703 }
1704 }
1705
Dave Houlton6f9059e2017-05-02 17:15:13 -06001706 // Checks that apply only to compressed images
1707 if (FormatIsCompressed(dst_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001708 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001709
1710 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001711 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1712 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1713 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001714 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 +01001715 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00144, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001716 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
1717 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001718 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001719 validation_error_map[VALIDATION_ERROR_09c00144]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001720 }
1721
Dave Houlton94a00372017-12-14 15:08:47 -07001722 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001723 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1724 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001725 skip |=
1726 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1727 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00146, "IMAGE",
1728 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
1729 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d). %s.",
1730 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width,
1731 validation_error_map[VALIDATION_ERROR_09c00146]);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001732 }
1733
Dave Houltonee281a52017-12-08 13:51:02 -07001734 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1735 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1736 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001737 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1738 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00148, "IMAGE",
1739 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1740 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
1741 "height (%d). %s.",
1742 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height,
1743 validation_error_map[VALIDATION_ERROR_09c00148]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001744 }
1745
Dave Houltonee281a52017-12-08 13:51:02 -07001746 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1747 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1748 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001749 skip |=
1750 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1751 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0014a, "IMAGE",
1752 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
1753 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d). %s.",
1754 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth,
1755 validation_error_map[VALIDATION_ERROR_09c0014a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001756 }
1757 } // Compressed
1758 }
1759 return skip;
1760}
1761
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001762bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001763 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1764 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001765 bool skip = false;
1766 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001767 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1768
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001769 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1770
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001771 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001772 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001773
1774 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1775 VkExtent3D src_copy_extent = region.extent;
1776 VkExtent3D dst_copy_extent =
1777 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1778
Dave Houlton6f9059e2017-05-02 17:15:13 -06001779 bool slice_override = false;
1780 uint32_t depth_slices = 0;
1781
1782 // Special case for copying between a 1D/2D array and a 3D image
1783 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1784 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1785 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001786 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001787 slice_override = (depth_slices != 1);
1788 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1789 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001790 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001791 slice_override = (depth_slices != 1);
1792 }
1793
Dave Houltonee281a52017-12-08 13:51:02 -07001794 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001795 std::stringstream ss;
1796 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001797 skip |=
1798 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1799 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001800 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001801
Dave Houltonee281a52017-12-08 13:51:02 -07001802 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001803 std::stringstream ss;
1804 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001805 skip |=
1806 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1807 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001808 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001809
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001810 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001811 // No chance of mismatch if we're overriding depth slice count
1812 if (!slice_override) {
1813 // The number of depth slices in srcSubresource and dstSubresource must match
1814 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1815 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001816 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1817 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001818 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001819 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1820 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001821 if (src_slices != dst_slices) {
1822 std::stringstream ss;
1823 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1824 << "] do not match";
1825 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 +01001826 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1827 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001828 }
1829 }
1830 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001831 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001832 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001833 std::stringstream ss;
1834 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1835 << "] do not match";
1836 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 -06001837 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1838 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001839 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001840 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001841
Dave Houltonf5217612018-02-02 16:18:52 -07001842 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1843 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
1844 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1845 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1846 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1847 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00112, "IMAGE", "%s. %s", str,
1848 validation_error_map[VALIDATION_ERROR_09c00112]);
1849 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001850 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001851
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001852 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001853 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001854 std::stringstream ss;
1855 ss << "vkCmdCopyImage: pRegion[" << i
1856 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1857 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 -06001858 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011c, "IMAGE", "%s. %s",
1859 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011c]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001860 }
1861
1862 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001863 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001864 std::stringstream ss;
1865 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1866 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 -06001867 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011e, "IMAGE", "%s. %s",
1868 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011e]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001869 }
1870
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001871 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001872 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1873 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001874 std::stringstream ss;
1875 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1876 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 -06001877 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600150, "IMAGE", "%s. %s",
1878 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600150]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001879 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001880
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001881 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1882 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001883 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1884 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001885 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1886 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 -06001887 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a60014e, "IMAGE", "%s. %s", str,
1888 validation_error_map[VALIDATION_ERROR_0a60014e]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001889 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001890
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001891 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001892 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001893 std::stringstream ss;
1894 ss << "vkCmdCopyImage: pRegions[" << i
1895 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1896 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 -07001897 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d40, "IMAGE", "%s. %s",
1898 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_19000d40]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001899 }
Dave Houltonee281a52017-12-08 13:51:02 -07001900 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001901 std::stringstream ss;
1902 ss << "vkCmdCopyImage: pRegions[" << i
1903 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1904 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 -07001905 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d42, "IMAGE", "%s. %s",
1906 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_19000d42]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001907 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001908
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001909 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1910 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001911 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001912 std::stringstream ss;
1913 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001914 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001915 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 -07001916 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d44, "IMAGE", "%s. %s",
1917 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_19000d44]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001918 }
Dave Houltonee281a52017-12-08 13:51:02 -07001919 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001920 std::stringstream ss;
1921 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001922 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001923 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 -07001924 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d46, "IMAGE", "%s. %s",
1925 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_19000d46]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001926 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001927
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001928 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1929 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1930 // 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 -07001931 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1932 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001933 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001934 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1935 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1936 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1937 << " ] exceeds the source image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001938 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 -06001939 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f4, "IMAGE", "%s. %s",
1940 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f4]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001941 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001942
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001943 // 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 -07001944 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1945 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001946 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001947 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
1948 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
1949 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
1950 << " ] exceeds the destination image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001951 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 -06001952 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f6, "IMAGE", "%s. %s",
1953 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f6]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001954 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001955 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001956
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07001958 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1959 if (slice_override) src_copy_extent.depth = depth_slices;
1960 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001961 if (extent_check & x_bit) {
1962 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001963 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00120, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1965 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001966 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001967 validation_error_map[VALIDATION_ERROR_09c00120]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001968 }
1969
1970 if (extent_check & y_bit) {
1971 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 -06001972 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00122, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001973 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1974 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001975 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001976 validation_error_map[VALIDATION_ERROR_09c00122]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001977 }
1978 if (extent_check & z_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_09c00126, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001981 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1982 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001983 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001984 validation_error_map[VALIDATION_ERROR_09c00126]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001985 }
1986
Dave Houltonee281a52017-12-08 13:51:02 -07001987 // Adjust dest extent if necessary
1988 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1989 if (slice_override) dst_copy_extent.depth = depth_slices;
1990
1991 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001992 if (extent_check & x_bit) {
1993 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 -06001994 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012c, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001995 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1996 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001997 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001998 validation_error_map[VALIDATION_ERROR_09c0012c]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001999 }
2000 if (extent_check & y_bit) {
2001 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 -06002002 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012e, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002003 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2004 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07002005 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002006 validation_error_map[VALIDATION_ERROR_09c0012e]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002007 }
2008 if (extent_check & z_bit) {
2009 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 -06002010 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00132, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002011 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2012 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07002013 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002014 validation_error_map[VALIDATION_ERROR_09c00132]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002015 }
2016
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002017 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2018 // must not overlap in memory
2019 if (src_image_state->image == dst_image_state->image) {
2020 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002021 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2022 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002023 std::stringstream ss;
2024 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2025 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 -06002026 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f8, "IMAGE", "%s. %s",
2027 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f8]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002028 }
2029 }
2030 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002031 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002032
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002033 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2034 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2035 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002036 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002037 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2038 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002039 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2040 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002041 }
2042 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002043 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2044 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002045 if (srcSize != destSize) {
2046 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2047 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 -06002048 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_1900010e, "IMAGE", "%s. %s", str,
2049 validation_error_map[VALIDATION_ERROR_1900010e]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002050 }
2051 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002052
Dave Houlton33c22b72017-02-28 13:16:02 -07002053 // Source and dest image sample counts must match
2054 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2055 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2056 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 -06002057 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000110, "IMAGE", "%s %s", str,
2058 validation_error_map[VALIDATION_ERROR_19000110]);
Dave Houlton33c22b72017-02-28 13:16:02 -07002059 }
2060
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002061 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2062 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002063 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002064 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002065 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002066 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002067 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002068 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002069 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002070 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002071 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002072 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002073 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002074 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002075 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002076 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002077 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002078 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2079 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002080 }
2081
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002082 return skip;
2083}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002084
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002085void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002086 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2087 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2088 // Make sure that all image slices are updated to correct layout
2089 for (uint32_t i = 0; i < region_count; ++i) {
2090 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2091 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2092 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002093 // Update bindings between images and cmd buffer
2094 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2095 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002096 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002097 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002098 function = [=]() {
2099 SetImageMemoryValid(device_data, dst_image_state, true);
2100 return false;
2101 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002102 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002103}
2104
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002105// Returns true if sub_rect is entirely contained within rect
2106static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2107 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2108 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2109 return false;
2110 return true;
2111}
2112
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002113bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2114 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002115 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002116 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2117
2118 bool skip = false;
2119 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002120 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2121 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002122 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002123 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002124 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002125 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2126 // 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 -07002127 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2128 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002129 skip |= log_msg(
2130 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2131 HandleToUint64(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
2132 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2133 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2134 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002135 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002136 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002137 }
2138
2139 // Validate that attachment is in reference list of active subpass
2140 if (cb_node->activeRenderPass) {
2141 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2142 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002143 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002144
2145 for (uint32_t i = 0; i < attachmentCount; i++) {
2146 auto clear_desc = &pAttachments[i];
2147 VkImageView image_view = VK_NULL_HANDLE;
2148
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002149 if (0 == clear_desc->aspectMask) {
2150 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 -06002151 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c03, "IMAGE", "%s",
2152 validation_error_map[VALIDATION_ERROR_01c00c03]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002153 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2154 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 -06002155 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00028, "IMAGE", "%s",
2156 validation_error_map[VALIDATION_ERROR_01c00028]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002157 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002158 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002159 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2160 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_1860001e, "DS",
2161 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
2162 clear_desc->colorAttachment, cb_node->activeSubpass,
2163 validation_error_map[VALIDATION_ERROR_1860001e]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002164 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2165 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002166 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer), __LINE__,
2167 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002168 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2169 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002170 } else {
2171 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002172 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002173 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002174 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2175 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2176 char const str[] =
Tobin Ehlisf9c50272018-03-12 08:19:33 -06002177 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002178 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 -06002179 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00026, "IMAGE", str, i,
2180 validation_error_map[VALIDATION_ERROR_01c00026]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002181 }
2182 } else { // Must be depth and/or stencil
2183 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2184 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Tobin Ehlisf9c50272018-03-12 08:19:33 -06002185 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits. %s";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002186 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 -06002187 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c01, "IMAGE", str, i,
2188 validation_error_map[VALIDATION_ERROR_01c00c01]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002189 }
2190 if (!subpass_desc->pDepthStencilAttachment ||
2191 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2192 skip |= log_msg(
2193 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002194 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002195 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002196 } else {
2197 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2198 }
2199 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002200 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002201 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002202 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002203 // The rectangular region specified by a given element of pRects must be contained within the render area of
2204 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002205 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2206 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2207 skip |=
2208 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 -06002209 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002210 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2211 "the current render pass instance. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002212 j, validation_error_map[VALIDATION_ERROR_18600020]);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002213 }
2214 } else {
2215 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2216 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2217 return log_msg(
2218 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2219 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
2220 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2221 "the current render pass instance. %s",
2222 j, validation_error_map[VALIDATION_ERROR_18600020]);
2223 }
2224 return false;
2225 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002226 }
2227 // The layers specified by a given element of pRects must be contained within every attachment that
2228 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002229 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002230 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2231 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002232 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2233 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600022, "DS",
2234 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2235 "of pAttachment[%d]. %s",
2236 j, i, validation_error_map[VALIDATION_ERROR_18600022]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002237 }
2238 }
2239 }
2240 }
2241 }
2242 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002243}
2244
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002245bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002246 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002247 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002248 bool skip = false;
2249 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002250 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2251 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2252 skip |=
2253 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002254 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002255 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002256
2257 // For each region, the number of layers in the image subresource should not be zero
2258 // For each region, src and dest image aspect must be color only
2259 for (uint32_t i = 0; i < regionCount; i++) {
2260 if (pRegions[i].srcSubresource.layerCount == 0) {
2261 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002262 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 +02002263 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002264 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002265 if (pRegions[i].dstSubresource.layerCount == 0) {
2266 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002267 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 +02002268 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002269 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002270 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2271 skip |= log_msg(
2272 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002273 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200216, "IMAGE",
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002274 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002275 validation_error_map[VALIDATION_ERROR_0a200216]);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002276 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002277 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2278 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2279 char const str[] =
2280 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2281 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 -06002282 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200214, "IMAGE", "%s. %s", str,
2283 validation_error_map[VALIDATION_ERROR_0a200214]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002284 }
2285 }
2286
2287 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2288 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002289 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 +02002290 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002291 }
2292 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2293 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002294 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 +02002295 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002296 }
2297 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2298 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2299 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 -06002300 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800202, "IMAGE", "%s. %s", str,
2301 validation_error_map[VALIDATION_ERROR_1c800202]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002302 }
2303 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2304 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2305 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 -06002306 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800206, "IMAGE", "%s. %s", str,
2307 validation_error_map[VALIDATION_ERROR_1c800206]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002308 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002309 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002310 } else {
2311 assert(0);
2312 }
2313 return skip;
2314}
2315
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002316void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2317 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002318 // Update bindings between images and cmd buffer
2319 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2320 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2321
2322 std::function<bool()> function = [=]() {
2323 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2324 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002325 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002326 function = [=]() {
2327 SetImageMemoryValid(device_data, dst_image_state, true);
2328 return false;
2329 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002330 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002331}
2332
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002333bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002334 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2335 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002336 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2337
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002338 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002339 if (cb_node) {
2340 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2341 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002342 if (cb_node && src_image_state && dst_image_state) {
2343 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002344 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002345 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002346 VALIDATION_ERROR_184001d4);
2347 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2348 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2349 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2350 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2351 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2352 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2353 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002354 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002355 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002356 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002357
Dave Houlton33c2d252017-06-09 17:08:32 -06002358 VkFormat src_format = src_image_state->createInfo.format;
2359 VkFormat dst_format = dst_image_state->createInfo.format;
2360 VkImageType src_type = src_image_state->createInfo.imageType;
2361 VkImageType dst_type = dst_image_state->createInfo.imageType;
2362
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002363 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002364 VkImageTiling tiling = src_image_state->createInfo.tiling;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002365 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002366 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2367 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2368 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b4, "IMAGE",
2369 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature. %s",
2370 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001b4]);
2371 }
2372
2373 if ((VK_FILTER_LINEAR == filter) &&
2374 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
2375 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2376 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d6, "IMAGE",
2377 "vkCmdBlitImage: source image format %s does not support linear filtering. %s",
2378 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d6]);
2379 }
2380
2381 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2382 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
2383 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2384 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d8, "IMAGE",
2385 "vkCmdBlitImage: source image format %s does not support cubic filtering. %s",
2386 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d8]);
2387 }
2388
2389 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2390 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2391 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001da, "IMAGE",
2392 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified. %s",
2393 validation_error_map[VALIDATION_ERROR_184001da]);
2394 }
2395
2396 props = GetFormatProperties(device_data, dst_format);
2397 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002398 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002399 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
2400 skip |=
2401 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2402 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001be, "IMAGE",
2403 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature. %s",
2404 string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_184001be]);
2405 }
2406
2407 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2408 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2409 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2410 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001c8, "IMAGE",
2411 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT. %s",
2412 validation_error_map[VALIDATION_ERROR_184001c8]);
2413 }
2414
2415 // Validate consistency for unsigned formats
2416 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2417 std::stringstream ss;
2418 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2419 << "the other one must also have unsigned integer format. "
2420 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2421 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2422 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001cc, "IMAGE", "%s. %s",
2423 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001cc]);
2424 }
2425
2426 // Validate consistency for signed formats
2427 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2428 std::stringstream ss;
2429 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2430 << "the other one must also have signed integer format. "
2431 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2432 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2433 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ca, "IMAGE", "%s. %s",
2434 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ca]);
2435 }
2436
2437 // Validate filter for Depth/Stencil formats
2438 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2439 std::stringstream ss;
2440 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2441 << "then filter must be VK_FILTER_NEAREST.";
2442 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2443 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d0, "IMAGE", "%s. %s",
2444 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001d0]);
2445 }
2446
2447 // Validate aspect bits and formats for depth/stencil images
2448 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2449 if (src_format != dst_format) {
2450 std::stringstream ss;
2451 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2452 << "stencil, the other one must have exactly the same format. "
2453 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2454 << string_VkFormat(dst_format);
2455 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2456 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ce, "IMAGE", "%s. %s",
2457 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ce]);
2458 }
2459
2460#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2461 for (uint32_t i = 0; i < regionCount; i++) {
2462 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2463
2464 if (FormatIsDepthAndStencil(src_format)) {
2465 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2466 std::stringstream ss;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002467 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of VK_IMAGE_ASPECT_DEPTH_BIT "
Dave Houlton33c2d252017-06-09 17:08:32 -06002468 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2469 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2470 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2471 "%s", ss.str().c_str());
2472 }
2473 }
2474 else if (FormatIsStencilOnly(src_format)) {
2475 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2476 std::stringstream ss;
2477 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2478 << "set in both the srcImage and dstImage";
2479 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2480 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2481 "%s", ss.str().c_str());
2482 }
2483 }
2484 else if (FormatIsDepthOnly(src_format)) {
2485 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2486 std::stringstream ss;
2487 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2488 << "set in both the srcImage and dstImage";
2489 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2490 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2491 "%s", ss.str().c_str());
2492 }
2493 }
2494 }
2495#endif
2496 } // Depth or Stencil
2497
2498 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002499 for (uint32_t i = 0; i < region_count; i++) {
2500 const VkImageBlit rgn = regions[i];
2501 bool hit_error = false;
2502 skip |=
2503 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2504 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2505 skip |=
2506 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2507 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002508
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002509 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002510 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2511 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002512 std::stringstream ss;
2513 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2514 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 +02002515 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2516 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002517 }
Dave Houlton48989f32017-05-26 15:01:46 -06002518 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2519 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002520 std::stringstream ss;
2521 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2522 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 +02002523 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2524 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002525 }
Dave Houlton48989f32017-05-26 15:01:46 -06002526 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002527 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2528 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 +02002529 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002530 }
Dave Houlton48989f32017-05-26 15:01:46 -06002531 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002532 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2533 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 +02002534 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002535 }
2536
2537 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002538 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002539 skip |=
2540 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 -06002541 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001de, "IMAGE",
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002542 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002543 i, validation_error_map[VALIDATION_ERROR_09a001de]);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002544 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002545
Dave Houlton48989f32017-05-26 15:01:46 -06002546 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002547 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 -06002548 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001dc, "IMAGE",
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002549 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002550 validation_error_map[VALIDATION_ERROR_09a001dc]);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002551 }
Dave Houlton48989f32017-05-26 15:01:46 -06002552
Dave Houlton33c2d252017-06-09 17:08:32 -06002553 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2554 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2555 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e2, "IMAGE",
2556 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
2557 "image format %s. %s",
2558 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format),
2559 validation_error_map[VALIDATION_ERROR_09a001e2]);
2560 }
2561
2562 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2563 skip |= log_msg(
2564 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2565 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e4, "IMAGE",
2566 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s. %s",
2567 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_09a001e4]);
2568 }
2569
Dave Houlton48989f32017-05-26 15:01:46 -06002570 // Validate source image offsets
2571 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002572 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002573 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2574 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2575 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ea, "IMAGE",
2576 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
2577 "of (%1d, %1d). These must be (0, 1). %s",
2578 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001ea]);
2579 }
2580 }
2581
Dave Houlton33c2d252017-06-09 17:08:32 -06002582 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002583 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2584 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2585 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ee, "IMAGE",
2586 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2587 "srcOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2588 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001ee]);
2589 }
2590 }
2591
Dave Houlton33c2d252017-06-09 17:08:32 -06002592 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002593 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2594 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002595 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002596 skip |= log_msg(
2597 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2598 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e6, "IMAGE",
2599 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d). %s", i,
2600 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width, validation_error_map[VALIDATION_ERROR_09a001e6]);
2601 }
2602 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2603 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002604 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002605 skip |= log_msg(
2606 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2607 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e8, "IMAGE",
2608 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d). %s", i,
2609 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height, validation_error_map[VALIDATION_ERROR_09a001e8]);
2610 }
2611 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2612 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002613 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002614 skip |= log_msg(
2615 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2616 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ec, "IMAGE",
2617 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d). %s", i,
2618 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth, validation_error_map[VALIDATION_ERROR_09a001ec]);
2619 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002620 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2621 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2622 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2623 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d. %s", i,
2624 rgn.srcSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001ae]);
2625 } else if (oob) {
2626 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2627 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2628 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions. %s", i,
2629 validation_error_map[VALIDATION_ERROR_184001ae]);
2630 }
Dave Houlton48989f32017-05-26 15:01:46 -06002631
2632 // Validate dest image offsets
2633 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002634 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002635 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2636 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2637 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f4, "IMAGE",
2638 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
2639 "(%1d, %1d). These must be (0, 1). %s",
2640 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001f4]);
2641 }
2642 }
2643
Dave Houlton33c2d252017-06-09 17:08:32 -06002644 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002645 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2646 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2647 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f8, "IMAGE",
2648 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2649 "dstOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2650 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001f8]);
2651 }
2652 }
2653
Dave Houlton33c2d252017-06-09 17:08:32 -06002654 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002655 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2656 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002657 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002658 skip |= log_msg(
2659 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2660 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f0, "IMAGE",
2661 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d). %s", i,
2662 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width, validation_error_map[VALIDATION_ERROR_09a001f0]);
2663 }
2664 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2665 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002666 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002667 skip |= log_msg(
2668 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2669 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f2, "IMAGE",
2670 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d). %s", i,
2671 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height, validation_error_map[VALIDATION_ERROR_09a001f2]);
2672 }
2673 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2674 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002675 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002676 skip |= log_msg(
2677 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2678 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f6, "IMAGE",
2679 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d). %s", i,
2680 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth, validation_error_map[VALIDATION_ERROR_09a001f6]);
2681 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002682 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002683 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 -06002684 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2685 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d. %s",
2686 i, rgn.dstSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001b0]);
2687 } else if (oob) {
2688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2689 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2690 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions. %s", i,
2691 validation_error_map[VALIDATION_ERROR_184001b0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002692 }
2693
Dave Houlton33c2d252017-06-09 17:08:32 -06002694 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2695 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2696 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2697 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2698 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e0, "IMAGE",
2699 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
2700 "layerCount other than 1. %s",
2701 i, validation_error_map[VALIDATION_ERROR_09a001e0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002702 }
2703 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002704 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002705 } else {
2706 assert(0);
2707 }
2708 return skip;
2709}
2710
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002711void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002712 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2713 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2714 // Make sure that all image slices are updated to correct layout
2715 for (uint32_t i = 0; i < region_count; ++i) {
2716 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2717 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2718 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002719 // Update bindings between images and cmd buffer
2720 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2721 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2722
2723 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002724 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002725 function = [=]() {
2726 SetImageMemoryValid(device_data, dst_image_state, true);
2727 return false;
2728 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002729 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002730}
2731
Tony Barbourdf013b92017-01-25 12:53:48 -07002732// This validates that the initial layout specified in the command buffer for
2733// the IMAGE is the same
2734// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002735bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002736 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2737 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002738 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002739 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002740 for (auto cb_image_data : pCB->imageLayoutMap) {
2741 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002742
Dave Houltonb3f4b282018-02-22 16:25:16 -07002743 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2744 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002745 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2746 // TODO: Set memory invalid which is in mem_tracker currently
2747 } else if (imageLayout != cb_image_data.second.initialLayout) {
2748 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002749 skip |= log_msg(
2750 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2751 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2752 "Cannot submit cmd buffer using image (0x%" PRIx64
2753 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2754 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2755 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2756 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002757 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002758 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2759 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002760 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002761 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2762 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002763 }
2764 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002765 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002766 }
2767 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002768 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002769}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002770
Tony Barbourdf013b92017-01-25 12:53:48 -07002771void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2772 for (auto cb_image_data : pCB->imageLayoutMap) {
2773 VkImageLayout imageLayout;
2774 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2775 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2776 }
2777}
2778
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002779// Print readable FlagBits in FlagMask
2780static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2781 std::string result;
2782 std::string separator;
2783
2784 if (accessMask == 0) {
2785 result = "[None]";
2786 } else {
2787 result = "[";
2788 for (auto i = 0; i < 32; i++) {
2789 if (accessMask & (1 << i)) {
2790 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2791 separator = " | ";
2792 }
2793 }
2794 result = result + "]";
2795 }
2796 return result;
2797}
2798
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002799// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2800// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002801// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002802static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2803 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2804 const char *type) {
2805 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2806 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002807
2808 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2809 if (accessMask & ~(required_bit | optional_bits)) {
2810 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002811 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 +02002812 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002813 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2814 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002815 }
2816 } else {
2817 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002818 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 +02002819 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002820 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
2821 "has previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002822 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2823 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002824 } else {
2825 std::string opt_bits;
2826 if (optional_bits != 0) {
2827 std::stringstream ss;
2828 ss << optional_bits;
2829 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2830 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002831 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 +02002832 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002833 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
2834 "previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002835 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2836 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002837 }
2838 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002839 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002840}
2841
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002842// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002843// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2844// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002845bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002846 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2847 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002848 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2849 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2850 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2851 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskieb9e73f2017-04-13 10:06:48 -06002852 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 -06002853 VALIDATION_ERROR_12200688, "DS", "Cannot clear attachment %d with invalid first layout %s. %s",
2854 attachment, string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_12200688]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002855 }
2856 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002857 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002858}
2859
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002860bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2861 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002862 bool skip = false;
2863
Jason Ekstranda1906302017-12-03 20:16:32 -08002864 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2865 VkFormat format = pCreateInfo->pAttachments[i].format;
2866 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2867 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2868 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Tobin Ehlis73836462018-02-13 09:35:47 -07002869 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2870 DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002871 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
2872 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2873 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2874 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002875 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07002876 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Tobin Ehlis73836462018-02-13 09:35:47 -07002877 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2878 DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002879 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
2880 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2881 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2882 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002883 }
2884 }
2885 }
2886
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002887 // Track when we're observing the first use of an attachment
2888 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2889 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2890 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002891
2892 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2893 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2894 auto attach_index = subpass.pInputAttachments[j].attachment;
2895 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2896
2897 switch (subpass.pInputAttachments[j].layout) {
2898 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2899 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2900 // These are ideal.
2901 break;
2902
2903 case VK_IMAGE_LAYOUT_GENERAL:
2904 // May not be optimal. TODO: reconsider this warning based on other constraints.
2905 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2906 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2907 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2908 break;
2909
2910 default:
2911 // No other layouts are acceptable
2912 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2913 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2914 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2915 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2916 }
2917
2918 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2919 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2920 subpass.pDepthStencilAttachment->attachment == attach_index &&
2921 subpass.pDepthStencilAttachment->layout != layout;
2922 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2923 found_layout_mismatch =
2924 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2925 }
2926 if (found_layout_mismatch) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002927 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2928 VALIDATION_ERROR_140006ae, "DS",
2929 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a "
2930 "depth/color attachment with a different layout. %s",
2931 i, j, attach_index, layout, validation_error_map[VALIDATION_ERROR_140006ae]);
Cort Stratton7547f772017-05-04 15:18:52 -07002932 }
2933
2934 if (attach_first_use[attach_index]) {
2935 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2936 pCreateInfo->pAttachments[attach_index]);
2937
2938 bool used_as_depth =
2939 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2940 bool used_as_color = false;
2941 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2942 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2943 }
2944 if (!used_as_depth && !used_as_color &&
2945 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2946 skip |= log_msg(
2947 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002948 VALIDATION_ERROR_1400069c, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002949 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002950 attach_index, attach_index, validation_error_map[VALIDATION_ERROR_1400069c]);
Cort Stratton7547f772017-05-04 15:18:52 -07002951 }
2952 }
2953 attach_first_use[attach_index] = false;
2954 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002955 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2956 auto attach_index = subpass.pColorAttachments[j].attachment;
2957 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2958
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002959 // TODO: Need a way to validate shared presentable images here, currently just allowing
2960 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2961 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002962 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002963 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002964 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002965 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2966 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002967 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002968
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002969 case VK_IMAGE_LAYOUT_GENERAL:
2970 // May not be optimal; TODO: reconsider this warning based on other constraints?
2971 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2972 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2973 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2974 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002975
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002976 default:
2977 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2978 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2979 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2980 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002981 }
2982
2983 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002984 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2985 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002986 }
2987 attach_first_use[attach_index] = false;
2988 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06002989
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002990 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2991 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002992 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2993 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2994 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06002995 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06002996
Dave Houltona9df0ce2018-02-07 10:51:23 -07002997 case VK_IMAGE_LAYOUT_GENERAL:
2998 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2999 // doing a bunch of transitions.
3000 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
3001 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
3002 "GENERAL layout for depth attachment may not give optimal performance.");
3003 break;
3004
3005 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3006 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3007 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3008 break;
3009 } else {
3010 // Intentionally fall through to generic error message
3011 }
3012
3013 default:
3014 // No other layouts are acceptable
3015 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3016 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
3017 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3018 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3019 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003020 }
3021
3022 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3023 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003024 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
3025 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003026 }
3027 attach_first_use[attach_index] = false;
3028 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003029 }
3030 return skip;
3031}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003032
3033// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003034bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3035 VkDeviceSize offset, VkDeviceSize end_offset) {
3036 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3037 bool skip = false;
3038 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3039 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003040 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3041 for (auto image_handle : mem_info->bound_images) {
3042 auto img_it = mem_info->bound_ranges.find(image_handle);
3043 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003044 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003045 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003046 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003047 for (auto layout : layouts) {
3048 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003049 skip |=
3050 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
3051 HandleToUint64(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003052 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3053 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003054 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003055 }
3056 }
3057 }
3058 }
3059 }
3060 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003061 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003062}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003063
3064// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3065// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003066static 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 -06003067 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003068 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003069
3070 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003071 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003072 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003073 if (strict) {
3074 correct_usage = ((actual & desired) == desired);
3075 } else {
3076 correct_usage = ((actual & desired) != 0);
3077 }
3078 if (!correct_usage) {
3079 if (msgCode == -1) {
3080 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003081 skip =
3082 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__,
3083 MEMTRACK_INVALID_USAGE_FLAG, "MEM",
3084 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3085 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003086 } else {
3087 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Dave Houltona9df0ce2018-02-07 10:51:23 -07003088 skip = log_msg(
3089 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__, msgCode, "MEM",
3090 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation. %s",
3091 type_str, obj_handle, func_name, type_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003092 }
3093 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003094 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003095}
3096
3097// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3098// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003099bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003100 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003101 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3102 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003103}
3104
3105// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3106// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003107bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003108 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003109 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3110 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003111}
3112
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003113bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003114 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003115 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3116
Chris Forbese0f511c2017-06-14 12:38:01 -07003117 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003118
3119 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
3120 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 -06003121 VALIDATION_ERROR_01400726, "DS",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003122 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
3123 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003124 validation_error_map[VALIDATION_ERROR_01400726]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003125 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003126
3127 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003128 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3129 VALIDATION_ERROR_01400728, "DS",
3130 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
3131 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set. %s",
3132 validation_error_map[VALIDATION_ERROR_01400728]);
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003133 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003134
3135 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003136 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3137 VALIDATION_ERROR_0140072a, "DS",
3138 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
3139 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set. %s",
3140 validation_error_map[VALIDATION_ERROR_0140072a]);
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003141 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003142 return skip;
3143}
3144
3145void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3146 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3147 GetBufferMap(device_data)
3148 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3149}
3150
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003151bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3152 bool skip = false;
3153 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003154 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3155 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003156 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003157 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3158 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003159 skip |= ValidateBufferUsageFlags(
3160 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 -06003161 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003162 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003163 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003164}
3165
3166void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3167 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3168}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003169
3170// For the given format verify that the aspect masks make sense
3171bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3172 const char *func_name) {
3173 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3174 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003175 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003176 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003177 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 -06003178 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003179 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003180 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003181 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003182 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 -06003183 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003184 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003185 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003186 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003187 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003188 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003189 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 -06003190 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003191 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
3192 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003193 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003194 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003195 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 -06003196 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003197 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
3198 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003199 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003200 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003201 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003202 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003203 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 -06003204 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003205 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003206 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003207 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003208 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 -06003209 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003210 "%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 -06003211 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003212 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003213 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003214 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003215 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 -06003216 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003217 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003218 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003219 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
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: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_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 }
3225 }
3226 return skip;
3227}
3228
Petr Krausffa94af2017-08-08 21:46:02 +02003229struct SubresourceRangeErrorCodes {
3230 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3231};
3232
3233bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3234 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3235 const char *image_layer_count_var_name, const uint64_t image_handle,
3236 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003237 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3238 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003239
3240 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003241 if (subresourceRange.baseMipLevel >= image_mip_count) {
3242 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3243 errorCodes.base_mip_err, "IMAGE",
3244 "%s: %s.baseMipLevel (= %" PRIu32
3245 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 "). %s",
3246 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count,
3247 validation_error_map[errorCodes.base_mip_err]);
3248 }
Petr Kraus4d718682017-05-18 03:38:41 +02003249
Petr Krausffa94af2017-08-08 21:46:02 +02003250 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3251 if (subresourceRange.levelCount == 0) {
3252 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3253 __LINE__, errorCodes.mip_count_err, "IMAGE", "%s: %s.levelCount is 0. %s", cmd_name, param_name,
3254 validation_error_map[errorCodes.mip_count_err]);
3255 } else {
3256 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003257
Petr Krausffa94af2017-08-08 21:46:02 +02003258 if (necessary_mip_count > image_mip_count) {
3259 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3260 __LINE__, errorCodes.mip_count_err, "IMAGE",
3261 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3262 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 "). %s",
3263 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
3264 necessary_mip_count, image_mip_count, validation_error_map[errorCodes.mip_count_err]);
3265 }
Petr Kraus4d718682017-05-18 03:38:41 +02003266 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003267 }
Petr Kraus4d718682017-05-18 03:38:41 +02003268
3269 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003270 if (subresourceRange.baseArrayLayer >= image_layer_count) {
3271 skip |=
3272 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3273 errorCodes.base_layer_err, "IMAGE",
3274 "%s: %s.baseArrayLayer (= %" PRIu32
3275 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 "). %s",
3276 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count,
3277 validation_error_map[errorCodes.base_layer_err]);
3278 }
Petr Kraus4d718682017-05-18 03:38:41 +02003279
Petr Krausffa94af2017-08-08 21:46:02 +02003280 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3281 if (subresourceRange.layerCount == 0) {
3282 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3283 __LINE__, errorCodes.layer_count_err, "IMAGE", "%s: %s.layerCount is 0. %s", cmd_name, param_name,
3284 validation_error_map[errorCodes.layer_count_err]);
3285 } else {
3286 const uint64_t necessary_layer_count =
3287 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003288
Petr Krausffa94af2017-08-08 21:46:02 +02003289 if (necessary_layer_count > image_layer_count) {
3290 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3291 __LINE__, errorCodes.layer_count_err, "IMAGE",
3292 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3293 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 "). %s",
3294 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
3295 necessary_layer_count, image_layer_count_var_name, image_layer_count,
3296 validation_error_map[errorCodes.layer_count_err]);
3297 }
Petr Kraus4d718682017-05-18 03:38:41 +02003298 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003299 }
Petr Kraus4d718682017-05-18 03:38:41 +02003300
Mark Lobodzinski602de982017-02-09 11:01:33 -07003301 return skip;
3302}
3303
Petr Krausffa94af2017-08-08 21:46:02 +02003304bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3305 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3306 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3307 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3308 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3309 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3310
3311 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3312 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3313
3314 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3315 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003316 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00d6c;
Petr Krausffa94af2017-08-08 21:46:02 +02003317 subresourceRangeErrorCodes.base_layer_err =
3318 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3319 subresourceRangeErrorCodes.layer_count_err =
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003320 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00d6e;
Petr Krausffa94af2017-08-08 21:46:02 +02003321
3322 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3323 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3324 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3325}
3326
3327bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3328 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3329 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3330 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003331 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800d38;
Petr Krausffa94af2017-08-08 21:46:02 +02003332 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003333 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800d3a;
Petr Krausffa94af2017-08-08 21:46:02 +02003334
3335 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3336 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3337 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3338}
3339
3340bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3341 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3342 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3343 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003344 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00d3c;
Petr Krausffa94af2017-08-08 21:46:02 +02003345 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003346 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00d3e;
Petr Krausffa94af2017-08-08 21:46:02 +02003347
3348 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3349 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3350 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3351}
3352
3353bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3354 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3355 const char *param_name) {
3356 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3357 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003358 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000d78;
Petr Krausffa94af2017-08-08 21:46:02 +02003359 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003360 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000d7a;
Petr Krausffa94af2017-08-08 21:46:02 +02003361
3362 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3363 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3364 subresourceRangeErrorCodes);
3365}
3366
Mark Lobodzinski602de982017-02-09 11:01:33 -07003367bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3368 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3369 bool skip = false;
3370 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3371 if (image_state) {
3372 skip |= ValidateImageUsageFlags(
3373 device_data, image_state,
3374 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houltona9df0ce2018-02-07 10:51:23 -07003375 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003376 false, -1, "vkCreateImageView()",
3377 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3378 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003379 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003380 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003381 skip |= ValidateCreateImageViewSubresourceRange(
3382 device_data, image_state,
3383 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3384 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003385
3386 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3387 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003388 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3389 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003390 VkFormat view_format = create_info->format;
3391 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003392 VkImageType image_type = image_state->createInfo.imageType;
3393 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003394
3395 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3396 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003397 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3398 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3399 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3400 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3401 std::stringstream ss;
3402 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3403 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3404 << ") format " << string_VkFormat(image_format)
3405 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3406 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3407 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3408 __LINE__, VALIDATION_ERROR_0ac007f4, "IMAGE", "%s %s", ss.str().c_str(),
3409 validation_error_map[VALIDATION_ERROR_0ac007f4]);
3410 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003411 }
3412 } else {
3413 // Format MUST be IDENTICAL to the format the image was created with
3414 if (image_format != view_format) {
3415 std::stringstream ss;
3416 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003417 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003418 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003419 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 -06003420 VALIDATION_ERROR_0ac007f6, "IMAGE", "%s %s", ss.str().c_str(),
3421 validation_error_map[VALIDATION_ERROR_0ac007f6]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003422 }
3423 }
3424
3425 // Validate correct image aspect bits for desired formats and format consistency
3426 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003427
3428 switch (image_type) {
3429 case VK_IMAGE_TYPE_1D:
3430 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3431 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3432 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3433 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3434 string_VkImageViewType(view_type), string_VkImageType(image_type),
3435 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3436 }
3437 break;
3438 case VK_IMAGE_TYPE_2D:
3439 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3440 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3441 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3442 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3443 __LINE__, VALIDATION_ERROR_0ac007d6, "IMAGE",
3444 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3445 string_VkImageViewType(view_type), string_VkImageType(image_type),
3446 validation_error_map[VALIDATION_ERROR_0ac007d6]);
3447 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_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 }
3455 break;
3456 case VK_IMAGE_TYPE_3D:
3457 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3458 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3459 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3460 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
3461 skip |= log_msg(
3462 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3463 __LINE__, VALIDATION_ERROR_0ac007da, "IMAGE",
3464 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3465 string_VkImageViewType(view_type), string_VkImageType(image_type),
3466 validation_error_map[VALIDATION_ERROR_0ac007da]);
3467 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3468 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003469 skip |=
3470 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3471 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3472 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3473 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
3474 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled. %s",
3475 string_VkImageViewType(view_type), string_VkImageType(image_type),
3476 validation_error_map[VALIDATION_ERROR_0ac007fa]);
Jeremy Kniager846ab732017-07-10 13:12:04 -06003477 }
3478 } else {
3479 skip |=
3480 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3481 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3482 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3483 string_VkImageViewType(view_type), string_VkImageType(image_type),
3484 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3485 }
3486 }
3487 } else {
3488 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3489 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3490 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3491 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3492 string_VkImageViewType(view_type), string_VkImageType(image_type),
3493 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3494 }
3495 }
3496 break;
3497 default:
3498 break;
3499 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003500
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003501 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003502 bool check_tiling_features = false;
3503 VkFormatFeatureFlags tiling_features = 0;
3504 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3505 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3506 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3507 };
3508 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3509 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3510 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3511 };
3512 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3513 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003514 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003515 error_codes = linear_error_codes;
3516 check_tiling_features = true;
3517 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003518 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003519 error_codes = optimal_error_codes;
3520 check_tiling_features = true;
3521 }
3522
3523 if (check_tiling_features) {
3524 if (tiling_features == 0) {
3525 skip |=
3526 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3527 error_codes[0], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003528 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003529 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[0]]);
3530 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
3531 skip |=
3532 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3533 error_codes[1], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003534 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3535 "VK_IMAGE_USAGE_SAMPLED_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003536 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[1]]);
3537 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
3538 skip |=
3539 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3540 error_codes[2], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003541 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3542 "VK_IMAGE_USAGE_STORAGE_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003543 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[2]]);
3544 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3545 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
3546 skip |=
3547 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3548 error_codes[3], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003549 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3550 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003551 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[3]]);
3552 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3553 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
3554 skip |=
3555 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3556 error_codes[4], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003557 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3558 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003559 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[4]]);
3560 }
3561 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003562 }
3563 return skip;
3564}
3565
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003566void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3567 auto image_view_map = GetImageViewMap(device_data);
3568 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3569
3570 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003571 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003572 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3573 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003574}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003575
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003576bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3577 BUFFER_STATE *dst_buffer_state) {
3578 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003579 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3580 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003581 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003582 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3583 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3584 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3585 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003586 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003587 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003588 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003589 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003590 return skip;
3591}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003592
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003593void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3594 BUFFER_STATE *dst_buffer_state) {
3595 // Update bindings between buffers and cmd buffer
3596 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3597 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3598
3599 std::function<bool()> function = [=]() {
3600 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3601 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003602 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003603 function = [=]() {
3604 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3605 return false;
3606 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003607 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003608}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003609
3610static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3611 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3612 bool skip = false;
3613 auto buffer_state = GetBufferState(device_data, buffer);
3614 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003615 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 +01003616 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS", "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
3617 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003618 } else {
3619 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003620 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 -06003621 HandleToUint64(buffer), __LINE__, VALIDATION_ERROR_23c00734, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +01003622 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer. %s", HandleToUint64(buffer),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003623 validation_error_map[VALIDATION_ERROR_23c00734]);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003624 }
3625 }
3626 return skip;
3627}
3628
3629bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3630 VK_OBJECT *obj_struct) {
3631 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003632 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003633 if (GetDisables(device_data)->destroy_image_view) return false;
3634 bool skip = false;
3635 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003636 skip |=
3637 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003638 }
3639 return skip;
3640}
3641
3642void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3643 VK_OBJECT obj_struct) {
3644 // Any bound cmd buffers are now invalid
3645 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3646 (*GetImageViewMap(device_data)).erase(image_view);
3647}
3648
3649bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3650 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003651 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003652 if (GetDisables(device_data)->destroy_buffer) return false;
3653 bool skip = false;
3654 if (*buffer_state) {
3655 skip |= validateIdleBuffer(device_data, buffer);
3656 }
3657 return skip;
3658}
3659
3660void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3661 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3662 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3663 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3664 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003665 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003666 }
3667 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003668 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003669 GetBufferMap(device_data)->erase(buffer_state->buffer);
3670}
3671
3672bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3673 VK_OBJECT *obj_struct) {
3674 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003675 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003676 if (GetDisables(device_data)->destroy_buffer_view) return false;
3677 bool skip = false;
3678 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003679 skip |=
3680 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003681 }
3682 return skip;
3683}
3684
3685void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3686 VK_OBJECT obj_struct) {
3687 // Any bound cmd buffers are now invalid
3688 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3689 GetBufferViewMap(device_data)->erase(buffer_view);
3690}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003691
3692bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3693 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003694 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003695 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003696 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003697 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3698 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003699 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003700 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003701 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003702 return skip;
3703}
3704
3705void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3706 std::function<bool()> function = [=]() {
3707 SetBufferMemoryValid(device_data, buffer_state, true);
3708 return false;
3709 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003710 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003711 // Update bindings between buffer and cmd buffer
3712 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003713}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003714
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003715bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3716 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003717 bool skip = false;
3718
3719 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003720 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3721 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003722 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 -06003723 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160018e, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003724 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
3725 "and 1, respectively. %s",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003726 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003727 validation_error_map[VALIDATION_ERROR_0160018e]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003728 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003729 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003730
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003731 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3732 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003733 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 -06003734 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600192, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003735 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
3736 "must be 0 and 1, respectively. %s",
3737 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003738 validation_error_map[VALIDATION_ERROR_01600192]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003739 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003740 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003741
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003742 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3743 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
3744 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 -06003745 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001aa, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003746 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
3747 "For 3D images these must be 0 and 1, respectively. %s",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003748 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003749 validation_error_map[VALIDATION_ERROR_016001aa]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003750 }
3751 }
3752
3753 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3754 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003755 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003756 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003757 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003758 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600182, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003759 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
3760 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003761 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01600182]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003762 }
3763
3764 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003765 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003766 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003767 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600184, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003768 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003769 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01600184]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003770 }
3771
3772 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3773 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
3774 skip |= log_msg(
3775 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003776 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600186, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003777 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
3778 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003779 validation_error_map[VALIDATION_ERROR_01600186]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003780 }
3781
3782 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3783 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3784 skip |= log_msg(
3785 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003786 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600188, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003787 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
3788 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003789 validation_error_map[VALIDATION_ERROR_01600188]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003790 }
3791
3792 // subresource aspectMask must have exactly 1 bit set
3793 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3794 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3795 if (aspect_mask_bits.count() != 1) {
3796 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 -06003797 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a8, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003798 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003799 validation_error_map[VALIDATION_ERROR_016001a8]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003800 }
3801
3802 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003803 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003804 skip |= log_msg(
3805 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003806 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a6, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003807 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
3808 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003809 validation_error_map[VALIDATION_ERROR_016001a6]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003810 }
3811
3812 // Checks that apply only to compressed images
3813 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3814 // reserves a place for these compressed image checks. This block of code could move there once the image
3815 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003816 if (FormatIsCompressed(image_state->createInfo.format)) {
3817 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003818
3819 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003820 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -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_01600196, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003824 "%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 -06003825 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01600196]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003826 }
3827
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003828 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003829 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003830 skip |= log_msg(
3831 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3832 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600198, "IMAGE",
3833 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d). %s.",
3834 function, i, pRegions[i].bufferImageHeight, block_size.height, validation_error_map[VALIDATION_ERROR_01600198]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003835 }
3836
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003837 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003838 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3839 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3840 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003841 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 -06003842 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019a, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003843 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3844 "width & height (%d, %d). %s.",
3845 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003846 block_size.height, validation_error_map[VALIDATION_ERROR_0160019a]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003847 }
3848
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003849 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003850 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3851 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003852 skip |= log_msg(
3853 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3854 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019c, "IMAGE",
3855 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3856 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
3857 function, i, pRegions[i].bufferOffset, block_size_in_bytes, validation_error_map[VALIDATION_ERROR_0160019c]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003858 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003859
3860 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003861 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003862 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003863 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3864 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 -06003865 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019e, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003866 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
3867 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
3868 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003869 mip_extent.width, validation_error_map[VALIDATION_ERROR_0160019e]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003870 }
3871
3872 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003873 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003874 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3875 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 -06003876 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a0, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003877 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
3878 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
3879 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003880 mip_extent.height, validation_error_map[VALIDATION_ERROR_016001a0]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003881 }
3882
3883 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003884 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003885 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3886 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 -06003887 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a2, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003888 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
3889 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
3890 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003891 mip_extent.depth, validation_error_map[VALIDATION_ERROR_016001a2]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003892 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003893 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003894 }
3895
3896 return skip;
3897}
3898
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003899static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3900 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003901 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003902 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003903
3904 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003905 VkExtent3D extent = pRegions[i].imageExtent;
3906 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003907
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003908 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3909 {
3910 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3911 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
3912 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
3913 extent.height, extent.depth);
3914 }
3915
3916 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3917
3918 // 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 -06003919 if (FormatIsCompressed(image_info->format)) {
3920 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003921 if (image_extent.width % block_extent.width) {
3922 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3923 }
3924 if (image_extent.height % block_extent.height) {
3925 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3926 }
3927 if (image_extent.depth % block_extent.depth) {
3928 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3929 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003930 }
3931
Dave Houltonfc1a4052017-04-27 14:32:45 -06003932 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003933 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 -07003934 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003935 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003936 }
3937 }
3938
3939 return skip;
3940}
3941
Chris Forbese8ba09a2017-06-01 17:39:02 -07003942static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003943 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3944 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003945 bool skip = false;
3946
3947 VkDeviceSize buffer_size = buff_state->createInfo.size;
3948
3949 for (uint32_t i = 0; i < regionCount; i++) {
3950 VkExtent3D copy_extent = pRegions[i].imageExtent;
3951
3952 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3953 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003954 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003955
Dave Houltonf3229d52017-02-21 15:59:08 -07003956 // Handle special buffer packing rules for specific depth/stencil formats
3957 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003958 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003959 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3960 switch (image_state->createInfo.format) {
3961 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003962 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003963 break;
3964 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003965 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003966 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003967 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003968 case VK_FORMAT_D24_UNORM_S8_UINT:
3969 unit_size = 4;
3970 break;
3971 default:
3972 break;
3973 }
3974 }
3975
Dave Houlton1d2022c2017-03-29 11:43:58 -06003976 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003977 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003978 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003979 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3980 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3981
3982 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3983 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3984 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003985 }
3986
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003987 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3988 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3989 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003990 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003991 } else {
3992 // Calculate buffer offset of final copied byte, + 1.
3993 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3994 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3995 max_buffer_offset *= unit_size; // convert to bytes
3996 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003997
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003998 if (buffer_size < max_buffer_offset) {
3999 skip |=
4000 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4001 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
4002 i, buffer_size, validation_error_map[msg_code]);
4003 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004004 }
4005 }
4006
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004007 return skip;
4008}
4009
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004010bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004011 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004012 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004013 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4014 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4015
4016 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004017 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004018
4019 // Command pool must support graphics, compute, or transfer operations
4020 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4021
4022 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4023 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4024 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 -06004025 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_19202415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004026 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
4027 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004028 validation_error_map[VALIDATION_ERROR_19202415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004029 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004030 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004031 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004032 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004033 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004034
4035 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004036 VALIDATION_ERROR_19200178);
4037 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
4038 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004039
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004040 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004041 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004042 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004043 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4044 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
4045 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004046 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004047 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004048 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
4049 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
4050 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004051 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06004052 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004053 }
4054 return skip;
4055}
4056
4057void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004058 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4059 VkImageLayout src_image_layout) {
4060 // Make sure that all image slices are updated to correct layout
4061 for (uint32_t i = 0; i < region_count; ++i) {
4062 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4063 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004064 // Update bindings between buffer/image and cmd buffer
4065 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004066 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004067
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004068 std::function<bool()> function = [=]() {
4069 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
4070 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004071 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004072 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004073 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004074 return false;
4075 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004076 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004077}
4078
4079bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004080 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004081 const VkBufferImageCopy *pRegions, const char *func_name) {
4082 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4083 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4084
4085 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004086 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004087
4088 // Command pool must support graphics, compute, or transfer operations
4089 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4090 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4091 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4092 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 -06004093 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_18e02415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004094 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
4095 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004096 validation_error_map[VALIDATION_ERROR_18e02415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004097 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004098 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004099 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004100 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004101 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004102 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004103 VALIDATION_ERROR_18e00166);
4104 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4105 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4106 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4107 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4108 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004109 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004110 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004111 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004112 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004113 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4114 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4115 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004116 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4117 "vkCmdCopyBufferToImage()");
4118 }
4119 return skip;
4120}
4121
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004122void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004123 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4124 VkImageLayout dst_image_layout) {
4125 // Make sure that all image slices are updated to correct layout
4126 for (uint32_t i = 0; i < region_count; ++i) {
4127 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4128 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004129 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004130 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004131 std::function<bool()> function = [=]() {
4132 SetImageMemoryValid(device_data, dst_image_state, true);
4133 return false;
4134 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004135 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004136 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004137 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004138}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004139
4140bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4141 const auto report_data = core_validation::GetReportData(device_data);
4142 bool skip = false;
4143 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4144
Dave Houlton1d960ff2018-01-19 12:17:05 -07004145 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004146 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4147 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4148 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004149 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 -06004150 __LINE__, VALIDATION_ERROR_2a6007ca, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004151 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004152 validation_error_map[VALIDATION_ERROR_2a6007ca]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004153 }
4154
4155 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4156 if (!image_entry) {
4157 return skip;
4158 }
4159
Dave Houlton1d960ff2018-01-19 12:17:05 -07004160 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004161 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004162 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 -06004163 __LINE__, VALIDATION_ERROR_2a6007c8, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004164 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004165 validation_error_map[VALIDATION_ERROR_2a6007c8]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004166 }
4167
Dave Houlton1d960ff2018-01-19 12:17:05 -07004168 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004169 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004170 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 -07004171 __LINE__, VALIDATION_ERROR_2a600d68, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004172 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07004173 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_2a600d68]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004174 }
4175
Dave Houlton1d960ff2018-01-19 12:17:05 -07004176 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004177 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004178 skip |=
4179 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 -07004180 __LINE__, VALIDATION_ERROR_2a600d6a, "IMAGE",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004181 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07004182 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_2a600d6a]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004183 }
4184
Dave Houlton1d960ff2018-01-19 12:17:05 -07004185 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004186 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004187 if (FormatIsMultiplane(img_format)) {
4188 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4189 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4190 if (FormatPlaneCount(img_format) > 2u) {
4191 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4192 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4193 }
4194 if (sub_aspect != (sub_aspect & allowed_flags)) {
4195 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4196 HandleToUint64(image), __LINE__, vuid, "IMAGE",
4197 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
4198 ") must be a single-plane specifier flag. %s",
4199 sub_aspect, validation_error_map[vuid]);
4200 }
4201 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004202 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004203 skip |= log_msg(
4204 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), __LINE__,
4205 VALIDATION_ERROR_0a400c01, "IMAGE",
4206 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
4207 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004208 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004209 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004210 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004211 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 -06004212 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004213 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
4214 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004215 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004216 }
4217 }
4218 return skip;
4219}