blob: 657751362d26b7147336b2f5ef2f15bc5e036f94 [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 Lobodzinski487a0d12018-03-30 10:09:03 -0600496 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
497 HandleToUint64(img_barrier->image), __LINE__, msg_code, "DS",
498 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
499 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
500 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700501 }
502 return skip;
503}
504
505// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600506bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700507 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700508 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700509
Mike Weiblen62d08a32017-03-07 22:18:27 -0700510 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
511 auto img_barrier = &pImageMemoryBarriers[i];
512 if (!img_barrier) continue;
513
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600514 auto image_state = GetImageState(device_data, img_barrier->image);
515 if (image_state) {
516 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
517 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
518 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
519
520 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
521 if (image_state->layout_locked) {
522 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600523 skip |= log_msg(
524 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600525 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, 0, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100526 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600527 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Kraus13c98a62017-12-09 00:22:39 +0100528 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600529 string_VkImageLayout(img_barrier->newLayout));
530 }
531 }
532
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600533 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600534 // For a Depth/Stencil image both aspects MUST be set
535 if (FormatIsDepthAndStencil(image_create_info->format)) {
536 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
537 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
538 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600539 skip |=
540 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
541 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), __LINE__,
542 VALIDATION_ERROR_0a00096e, "DS",
543 "%s: Image barrier 0x%p references image 0x%" PRIx64
544 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
545 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
546 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600547 }
548 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600549 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
550 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700551
Mike Weiblen62d08a32017-03-07 22:18:27 -0700552 for (uint32_t j = 0; j < level_count; j++) {
553 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
554 for (uint32_t k = 0; k < layer_count; k++) {
555 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600556 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
557 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
558 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
559 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700560 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
561 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
562 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
563 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
564 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
565 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
566 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
567 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700568 }
569 }
570 }
571 return skip;
572}
573
Chris Forbes4de4b132017-08-21 11:27:08 -0700574static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600575 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700576
577 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600578 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700579}
580
Chris Forbes399a6782017-08-18 15:00:48 -0700581void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700582 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700583 for (uint32_t i = 0; i < memBarrierCount; ++i) {
584 auto mem_barrier = &pImgMemBarriers[i];
585 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700586
Chris Forbes4de4b132017-08-21 11:27:08 -0700587 // For ownership transfers, the barrier is specified twice; as a release
588 // operation on the yielding queue family, and as an acquire operation
589 // on the acquiring queue family. This barrier may also include a layout
590 // transition, which occurs 'between' the two operations. For validation
591 // purposes it doesn't seem important which side performs the layout
592 // transition, but it must not be performed twice. We'll arbitrarily
593 // choose to perform it as part of the acquire operation.
594 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
595 continue;
596 }
597
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600598 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
599 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
600 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
601
Dave Houltonb3f4b282018-02-22 16:25:16 -0700602 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
603 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
604 // for all (potential) layer sub_resources.
605 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
606 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
607 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
608 }
609
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600610 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700611 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600612 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700613 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Chris Forbes399a6782017-08-18 15:00:48 -0700614 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
615 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
616 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
617 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700618 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Chris Forbes399a6782017-08-18 15:00:48 -0700619 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
620 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
621 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700622 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700623 }
624 }
625 }
626}
627
Tobin Ehlisc8266452017-04-07 12:20:30 -0600628bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600629 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600630 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700631 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600632 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600633 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700634
635 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
636 uint32_t layer = i + subLayers.baseArrayLayer;
637 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
638 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600639 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
640 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600641 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600642 // TODO: Improve log message in the next pass
Petr Kraus13c98a62017-12-09 00:22:39 +0100643 skip |= log_msg(
644 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
645 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
646 "%s: Cannot use image 0x%" PRIx64 " with specific layout %s that doesn't match the actual current layout %s.",
647 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600648 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700649 }
650 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600651 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
652 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
653 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700654 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
655 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600656 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200657 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer), __LINE__,
658 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100659 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
660 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700661 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600662 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600663 if (image_state->shared_presentable) {
664 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
665 // TODO: Add unique error id when available.
666 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
667 __LINE__, msg_code, "DS",
668 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
669 string_VkImageLayout(optimal_layout));
670 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600671 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700672 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600673 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600674 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 +0200675 HandleToUint64(cb_node->commandBuffer), __LINE__, msg_code, "DS",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600676 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
677 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700678 }
679 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600680 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700681}
682
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700683void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
684 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700685 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700686 if (!renderPass) return;
687
688 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
689 if (framebuffer_state) {
690 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
691 auto image_view = framebuffer_state->createInfo.pAttachments[i];
692 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
693 }
694 }
695}
Dave Houltone19e20d2018-02-02 16:32:41 -0700696
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700697bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700698 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600699 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700700 const debug_report_data *report_data = core_validation::GetReportData(device_data);
701
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600702 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600703 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600704 VALIDATION_ERROR_09e0075e, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600705
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600706 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600707 }
708
Dave Houlton130c0212018-01-29 13:39:56 -0700709 bool optimal_tiling = (VK_IMAGE_TILING_OPTIMAL == pCreateInfo->tiling);
710 const char *tiling_string = string_VkImageTiling(pCreateInfo->tiling);
711 const char *format_string = string_VkFormat(pCreateInfo->format);
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600712 VkFormatProperties properties = GetFormatProperties(device_data, pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700713 VkFormatFeatureFlags features = (optimal_tiling ? properties.optimalTilingFeatures : properties.linearTilingFeatures);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600714
Dave Houlton130c0212018-01-29 13:39:56 -0700715 if (0 == features) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600716 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700717 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ac : VALIDATION_ERROR_09e007a2);
718 ss << "vkCreateImage format parameter " << format_string << " is an unsupported format";
719 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600720 "IMAGE", "%s.", ss.str().c_str());
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600721 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600722 }
723
Dave Houlton130c0212018-01-29 13:39:56 -0700724 if ((pCreateInfo->usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600725 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700726 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ae : VALIDATION_ERROR_09e007a4);
727 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_SAMPLED_BIT is not supported for format " << format_string << " with tiling "
728 << tiling_string;
729 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600730 "IMAGE", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700731 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600732
Dave Houlton130c0212018-01-29 13:39:56 -0700733 if ((pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
734 std::stringstream ss;
735 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b0 : VALIDATION_ERROR_09e007a6);
736 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_STORAGE_BIT is not supported for format " << format_string << " with tiling "
737 << tiling_string;
738 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600739 "IMAGE", "%s.", ss.str().c_str());
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600740 }
741
Lenny Komowb79f04a2017-09-18 17:07:00 -0600742 // TODO: Add checks for EXTENDED_USAGE images to validate images are compatible
743 // For EXTENDED_USAGE images, format can match any image COMPATIBLE with original image
744 if (!GetDeviceExtensions(device_data)->vk_khr_maintenance2 || !(pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR)) {
745 // Validate that format supports usage as color attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700746 if ((pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
747 (0 == (features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT))) {
748 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b2 : VALIDATION_ERROR_09e007a8);
749 std::stringstream ss;
750 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_COLOR_ATTACHMENT is not supported for format " << format_string
751 << " with tiling " << tiling_string;
752 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600753 "IMAGE", "%s.", ss.str().c_str());
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600754 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600755
Lenny Komowb79f04a2017-09-18 17:07:00 -0600756 // Validate that format supports usage as depth/stencil attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700757 if ((pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
758 (0 == (features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
759 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b4 : VALIDATION_ERROR_09e007aa);
760 std::stringstream ss;
761 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT is not supported for format " << format_string
762 << " with tiling " << tiling_string;
763 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600764 "IMAGE", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700765 }
766 }
767
768 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
769 std::stringstream ss;
770 ss << "vkCreateImage: Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set";
771 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600772 VALIDATION_ERROR_09e0076a, "IMAGE", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700773 }
774
775 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
776 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
777 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
778 if (VK_SUCCESS != err) {
779 std::stringstream ss;
780 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
781 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
782 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600783 VALIDATION_ERROR_09e00758, "IMAGE", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700784 return skip;
785 }
786
787 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
788 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
789 std::stringstream ss;
790 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
791 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600792 VALIDATION_ERROR_09e0076e, "IMAGE", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700793 }
794
795 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
796 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
797 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
798 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600799 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700800 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600801 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600802 VALIDATION_ERROR_09e00770, "IMAGE", "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600803 }
Dave Houlton130c0212018-01-29 13:39:56 -0700804 } else {
805 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
806 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600807 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700808 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
809 "format "
810 << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600811 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600812 VALIDATION_ERROR_09e00772, "IMAGE", "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600813 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600814 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700815 }
816
Dave Houlton130c0212018-01-29 13:39:56 -0700817 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
818 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
819 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
820 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
821 std::stringstream ss;
822 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
823 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600824 VALIDATION_ERROR_09e00776, "IMAGE", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700825 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700826 }
827
Dave Houlton130c0212018-01-29 13:39:56 -0700828 // 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 -0700829 // 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 -0700830 // implementation shown. DJH
831 //
832 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
833 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
834 // device_limits->maxImageDimension3D)) {
835 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
836 std::stringstream ss;
837 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
838 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600839 VALIDATION_ERROR_09e0077e, "IMAGE", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700840 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700841
Dave Houlton130c0212018-01-29 13:39:56 -0700842 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
843 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
844 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
845 std::stringstream ss;
846 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
847 "maxFramebufferWidth";
848 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600849 VALIDATION_ERROR_09e00788, "IMAGE", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700850 }
851
852 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
853 std::stringstream ss;
854 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
855 "maxFramebufferHeight";
856 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600857 VALIDATION_ERROR_09e0078a, "IMAGE", "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700858 }
859
860 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
861 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
862 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
863
864 // Round up to imageGranularity boundary
865 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
866 uint64_t ig_mask = imageGranularity - 1;
867 total_size = (total_size + ig_mask) & ~ig_mask;
868
869 if (total_size > format_limits.maxResourceSize) {
Petr Kraus131a4a92018-03-14 19:53:58 +0100870 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 -0600871 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
Dave Houltona9df0ce2018-02-07 10:51:23 -0700872 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
873 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -0700874 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700875 }
876
Dave Houlton130c0212018-01-29 13:39:56 -0700877 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600878 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 -0700879 VALIDATION_ERROR_09e00780, "Image",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600880 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d.", pCreateInfo->arrayLayers,
881 format_limits.maxArrayLayers);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700882 }
883
Dave Houlton130c0212018-01-29 13:39:56 -0700884 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600885 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600886 VALIDATION_ERROR_09e0078e, "Image", "CreateImage samples %s is not supported by format 0x%.8X.",
887 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700888 }
889
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600890 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600891 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
892 DRAWSTATE_INVALID_FEATURE, "DS",
893 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
894 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600895 }
896
Lenny Komowb79f04a2017-09-18 17:07:00 -0600897 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
898 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
899 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
900 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
901 // TODO: Add Maintenance2 VUID
902 skip |=
903 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
904 VALIDATION_ERROR_UNDEFINED, "DS",
905 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
906 "format must be block, ETC or ASTC compressed, but is %s",
907 string_VkFormat(pCreateInfo->format));
908 }
909 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
910 // TODO: Add Maintenance2 VUID
911 skip |=
912 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
913 VALIDATION_ERROR_UNDEFINED, "DS",
914 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
915 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
916 }
917 }
918 }
919
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600920 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700921}
922
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700923void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700924 IMAGE_LAYOUT_NODE image_state;
925 image_state.layout = pCreateInfo->initialLayout;
926 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700927 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 -0700928 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700929 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
930 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700931}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700932
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700933bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700934 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700935 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200936 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700937 if (disabled->destroy_image) return false;
938 bool skip = false;
939 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600940 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
941 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700942 }
943 return skip;
944}
945
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700946void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700947 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
948 // Clean up memory mapping, bindings and range references for image
949 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700950 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700951 if (mem_info) {
952 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
953 }
954 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600955 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700956 // Remove image from imageMap
957 core_validation::GetImageMap(device_data)->erase(image);
958 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
959 core_validation::GetImageSubresourceMap(device_data);
960
961 const auto &sub_entry = imageSubresourceMap->find(image);
962 if (sub_entry != imageSubresourceMap->end()) {
963 for (const auto &pair : sub_entry->second) {
964 core_validation::GetImageLayoutMap(device_data)->erase(pair);
965 }
966 imageSubresourceMap->erase(sub_entry);
967 }
968}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700969
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700970bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700971 bool skip = false;
972 const debug_report_data *report_data = core_validation::GetReportData(device_data);
973
974 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
975 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
976 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 +0200977 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700978 }
979
Dave Houlton1d2022c2017-03-29 11:43:58 -0600980 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700981 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
982 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600983 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600984 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700985 char const str[] = "vkCmdClearColorImage called with compressed image.";
986 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600987 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700988 }
989
990 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
991 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
992 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600993 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_18800004, "IMAGE", "%s.", str);
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",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001058 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1059 string_VkImageLayout(dest_image_layout));
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",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001079 "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1080 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001081 }
1082 }
1083 }
1084 }
1085
1086 return skip;
1087}
1088
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001089void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1090 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001091 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1092 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1093 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001094
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001095 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1096 uint32_t level = level_index + range.baseMipLevel;
1097 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1098 uint32_t layer = layer_index + range.baseArrayLayer;
1099 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001100 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001101 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1102 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 -07001103 }
1104 }
1105 }
1106}
1107
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001108bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001109 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1110 bool skip = false;
1111 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001112 auto cb_node = GetCBNode(dev_data, commandBuffer);
1113 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001114 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001115 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001116 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001117 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001118 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001119 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001120 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001121 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001122 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001123 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001124 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001125 }
1126 }
1127 return skip;
1128}
1129
1130// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001131void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001132 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001133 auto cb_node = GetCBNode(dev_data, commandBuffer);
1134 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001135 if (cb_node && image_state) {
1136 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1137 std::function<bool()> function = [=]() {
1138 SetImageMemoryValid(dev_data, image_state, true);
1139 return false;
1140 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001141 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001142 for (uint32_t i = 0; i < rangeCount; ++i) {
1143 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1144 }
1145 }
1146}
1147
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001148bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1149 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001150 const VkImageSubresourceRange *pRanges) {
1151 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001152 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1153
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001154 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001155 auto cb_node = GetCBNode(device_data, commandBuffer);
1156 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001157 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001158 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001159 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001160 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001161 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001162 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001163 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001164 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001165 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001166 skip |=
1167 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001168 // Image aspect must be depth or stencil or both
1169 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1170 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1171 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001172 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1173 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001174 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 +02001175 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001176 }
1177 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001178 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001179 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001180 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001181 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a0001c, "IMAGE", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001182 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001183 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1184 char const str[] =
1185 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1186 "set.";
1187 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001188 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00012, "IMAGE", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001189 }
1190 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1191 VkImageTiling tiling = image_state->createInfo.tiling;
1192 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1193 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1194 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001195 skip |=
1196 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1197 __LINE__, VALIDATION_ERROR_18a00010, "IMAGE",
1198 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1199 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR.",
1200 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling));
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001201 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001202 }
1203 return skip;
1204}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001205
1206// Returns true if [x, xoffset] and [y, yoffset] overlap
1207static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1208 bool result = false;
1209 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1210 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1211
1212 if (intersection_max > intersection_min) {
1213 result = true;
1214 }
1215 return result;
1216}
1217
1218// Returns true if two VkImageCopy structures overlap
Dave Houltonf5217612018-02-02 16:18:52 -07001219static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001220 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001221
1222 if (is_multiplane && (src->srcSubresource.aspectMask != dst->dstSubresource.aspectMask)) {
1223 return result;
1224 }
1225
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001226 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1227 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1228 dst->dstSubresource.layerCount))) {
1229 result = true;
1230 switch (type) {
1231 case VK_IMAGE_TYPE_3D:
1232 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1233 // Intentionally fall through to 2D case
1234 case VK_IMAGE_TYPE_2D:
1235 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1236 // Intentionally fall through to 1D case
1237 case VK_IMAGE_TYPE_1D:
1238 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1239 break;
1240 default:
1241 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1242 assert(false);
1243 }
1244 }
1245 return result;
1246}
1247
Dave Houltonfc1a4052017-04-27 14:32:45 -06001248// Returns non-zero if offset and extent exceed image extents
1249static const uint32_t x_bit = 1;
1250static const uint32_t y_bit = 2;
1251static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001252static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001253 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001254 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001255 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1256 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001257 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001258 }
1259 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1260 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001261 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001262 }
1263 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1264 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001265 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001266 }
1267 return result;
1268}
1269
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001270// Test if two VkExtent3D structs are equivalent
1271static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1272 bool result = true;
1273 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1274 (extent->depth != other_extent->depth)) {
1275 result = false;
1276 }
1277 return result;
1278}
1279
Dave Houltonee281a52017-12-08 13:51:02 -07001280// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1281// Destination image texel extents must be adjusted by block size for the dest validation checks
1282VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1283 VkExtent3D adjusted_extent = extent;
1284 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1285 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1286 adjusted_extent.width /= block_size.width;
1287 adjusted_extent.height /= block_size.height;
1288 adjusted_extent.depth /= block_size.depth;
1289 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1290 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1291 adjusted_extent.width *= block_size.width;
1292 adjusted_extent.height *= block_size.height;
1293 adjusted_extent.depth *= block_size.depth;
1294 }
1295 return adjusted_extent;
1296}
1297
Dave Houlton6f9059e2017-05-02 17:15:13 -06001298// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001299static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1300 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001301
1302 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001303 if (mip >= img->createInfo.mipLevels) {
1304 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001305 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001306
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001307 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
Dave Houltonfc1a4052017-04-27 14:32:45 -06001308 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001309 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1310 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1311 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001312
Dave Houlton6f9059e2017-05-02 17:15:13 -06001313 // Image arrays have an effective z extent that isn't diminished by mip level
1314 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001315 extent.depth = img->createInfo.arrayLayers;
1316 }
1317
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001318 return extent;
1319}
1320
1321// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001322static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001323 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1324}
1325
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001326// Test if the extent argument has any dimensions set to 0.
1327static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1328 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1329}
1330
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001331// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1332static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1333 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1334 VkExtent3D granularity = {0, 0, 0};
1335 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1336 if (pPool) {
1337 granularity =
1338 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001339 if (FormatIsCompressed(img->createInfo.format)) {
1340 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001341 granularity.width *= block_size.width;
1342 granularity.height *= block_size.height;
1343 }
1344 }
1345 return granularity;
1346}
1347
1348// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1349static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1350 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001351 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1352 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001353 valid = false;
1354 }
1355 return valid;
1356}
1357
1358// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1359static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1360 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1361 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1362 bool skip = false;
1363 VkExtent3D offset_extent = {};
1364 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1365 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1366 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001367 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001368 // If the queue family image transfer granularity is (0, 0, 0), then the offset must always be (0, 0, 0)
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001369 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001370 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1371 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001372 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) when the command buffer's queue family "
1373 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001374 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001375 }
1376 } else {
1377 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1378 // integer multiples of the image transfer granularity.
1379 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001380 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1381 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001382 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1383 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001384 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1385 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001386 }
1387 }
1388 return skip;
1389}
1390
1391// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1392static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1393 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001394 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001395 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1396 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001397 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001398 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1399 // subresource extent.
1400 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001401 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1402 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1403 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1404 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1405 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1406 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001407 }
1408 } else {
1409 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1410 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1411 // subresource extent dimensions.
1412 VkExtent3D offset_extent_sum = {};
1413 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1414 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1415 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001416 bool x_ok = true;
1417 bool y_ok = true;
1418 bool z_ok = true;
1419 switch (image_type) {
1420 case VK_IMAGE_TYPE_3D:
1421 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1422 (subresource_extent->depth == offset_extent_sum.depth));
1423 // Intentionally fall through to 2D case
1424 case VK_IMAGE_TYPE_2D:
1425 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1426 (subresource_extent->height == offset_extent_sum.height));
1427 // Intentionally fall through to 1D case
1428 case VK_IMAGE_TYPE_1D:
1429 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1430 (subresource_extent->width == offset_extent_sum.width));
1431 break;
1432 default:
1433 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1434 assert(false);
1435 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001436 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001437 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1438 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1439 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1440 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1441 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1442 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1443 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1444 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001445 }
1446 }
1447 return skip;
1448}
1449
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001450// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001451bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1452 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1453 const uint32_t i, const char *function) {
1454 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001455 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001456 // TODO: Add granularity checking for compressed formats
1457
1458 // bufferRowLength must be a multiple of the compressed texel block width
1459 // bufferImageHeight must be a multiple of the compressed texel block height
1460 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1461 // bufferOffset must be a multiple of the compressed texel block size in bytes
1462 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1463 // must equal the image subresource width
1464 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1465 // must equal the image subresource height
1466 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1467 // must equal the image subresource depth
1468 } else {
1469 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001470 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1471 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1472 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001473 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001474 }
1475 return skip;
1476}
1477
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001478// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001479bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001480 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1481 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001482 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001483 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001484 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001485 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001486 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001487 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001488 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001489 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001490
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001491 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001492 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001493 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houltonee281a52017-12-08 13:51:02 -07001494 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001495 const VkExtent3D dest_effective_extent =
1496 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001497 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001498 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001499 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001500 return skip;
1501}
1502
Dave Houlton6f9059e2017-05-02 17:15:13 -06001503// Validate contents of a VkImageCopy struct
1504bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1505 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1506 bool skip = false;
1507
1508 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001509 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001510
1511 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001512 const VkExtent3D src_copy_extent = region.extent;
1513 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001514 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1515
Dave Houlton6f9059e2017-05-02 17:15:13 -06001516 bool slice_override = false;
1517 uint32_t depth_slices = 0;
1518
1519 // Special case for copying between a 1D/2D array and a 3D image
1520 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1521 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001522 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001523 slice_override = (depth_slices != 1);
1524 } else if ((VK_IMAGE_TYPE_3D == dst_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != src_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001525 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001526 slice_override = (depth_slices != 1);
1527 }
1528
1529 // Do all checks on source image
1530 //
1531 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001532 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1533 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1534 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00124, "IMAGE",
1535 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001536 "be 0 and 1, respectively.",
1537 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001538 }
1539 }
1540
Dave Houlton533be9f2018-03-26 17:08:30 -06001541 // VUID-VkImageCopy-srcImage-01785
1542 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1543 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1544 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00df2, "IMAGE",
1545 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001546 "these must be 0 and 1, respectively.",
1547 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001548 }
1549
Dave Houlton533be9f2018-03-26 17:08:30 -06001550 // VUID-VkImageCopy-srcImage-01787
1551 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1552 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1553 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00df6, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001554 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
1555 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06001556 }
1557
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001558 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001559 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001560 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001561 skip |=
1562 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001563 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001564 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001565 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1566 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001567 }
1568 }
1569 } else { // Pre maint 1
1570 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001571 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001572 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1573 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1574 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1575 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001576 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1577 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001578 }
1579 }
1580 }
1581
Dave Houlton6f9059e2017-05-02 17:15:13 -06001582 // Checks that apply only to compressed images
1583 if (FormatIsCompressed(src_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001584 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001585
1586 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001587 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1588 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1589 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001590 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 +01001591 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001592 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001593 "texel width & height (%d, %d)..",
1594 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001595 }
1596
Dave Houlton94a00372017-12-14 15:08:47 -07001597 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001598 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1599 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001600 skip |=
1601 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001602 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013c, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001603 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001604 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d)..",
1605 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001606 }
1607
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001608 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001609 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1610 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001611 skip |=
1612 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001613 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013e, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001614 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001615 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d)..",
1616 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001617 }
1618
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001619 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001620 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1621 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001622 skip |=
1623 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001624 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00140, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001625 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001626 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d)..",
1627 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001628 }
1629 } // Compressed
1630
1631 // Do all checks on dest image
1632 //
1633 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001634 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001635 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1636 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00130, "IMAGE",
1637 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001638 "these must be 0 and 1, respectively.",
1639 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001640 }
1641 }
1642
Dave Houlton533be9f2018-03-26 17:08:30 -06001643 // VUID-VkImageCopy-dstImage-01786
1644 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
1645 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1646 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00df4, "IMAGE",
1647 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001648 "and 1, respectively.",
1649 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06001650 }
1651
1652 // VUID-VkImageCopy-dstImage-01788
1653 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
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_09c00df8, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001656 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
1657 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001658 }
1659
1660 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001661 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001662 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 +01001663 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001664 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001665 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1666 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001667 }
1668 }
1669 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001670 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001671 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001672 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001673 skip |=
1674 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001675 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001676 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001677 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1678 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001679 }
1680 }
1681 } else { // Pre maint 1
1682 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001683 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001684 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1685 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1686 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1687 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001688 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1689 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001690 }
1691 }
1692 }
1693
Dave Houlton6f9059e2017-05-02 17:15:13 -06001694 // Checks that apply only to compressed images
1695 if (FormatIsCompressed(dst_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001696 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001697
1698 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001699 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1700 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1701 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001702 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 +01001703 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00144, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001704 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001705 "texel width & height (%d, %d)..",
1706 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001707 }
1708
Dave Houlton94a00372017-12-14 15:08:47 -07001709 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001710 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1711 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001712 skip |=
1713 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1714 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00146, "IMAGE",
1715 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001716 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d)..",
1717 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001718 }
1719
Dave Houltonee281a52017-12-08 13:51:02 -07001720 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1721 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1722 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001723 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1724 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00148, "IMAGE",
1725 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1726 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001727 "height (%d)..",
1728 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001729 }
1730
Dave Houltonee281a52017-12-08 13:51:02 -07001731 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1732 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1733 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001734 skip |=
1735 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1736 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0014a, "IMAGE",
1737 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001738 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d)..",
1739 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001740 }
1741 } // Compressed
1742 }
1743 return skip;
1744}
1745
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001746bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001747 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1748 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001749 bool skip = false;
1750 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001751 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1752
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001753 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1754
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001755 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001756 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001757
1758 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1759 VkExtent3D src_copy_extent = region.extent;
1760 VkExtent3D dst_copy_extent =
1761 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1762
Dave Houlton6f9059e2017-05-02 17:15:13 -06001763 bool slice_override = false;
1764 uint32_t depth_slices = 0;
1765
1766 // Special case for copying between a 1D/2D array and a 3D image
1767 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1768 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1769 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001770 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001771 slice_override = (depth_slices != 1);
1772 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1773 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001774 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001775 slice_override = (depth_slices != 1);
1776 }
1777
Dave Houltonee281a52017-12-08 13:51:02 -07001778 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001779 std::stringstream ss;
1780 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001781 skip |=
1782 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1783 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001784 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001785
Dave Houltonee281a52017-12-08 13:51:02 -07001786 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001787 std::stringstream ss;
1788 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001789 skip |=
1790 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1791 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001792 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001793
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001794 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001795 // No chance of mismatch if we're overriding depth slice count
1796 if (!slice_override) {
1797 // The number of depth slices in srcSubresource and dstSubresource must match
1798 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1799 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001800 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1801 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001802 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001803 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1804 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001805 if (src_slices != dst_slices) {
1806 std::stringstream ss;
1807 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1808 << "] do not match";
1809 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001810 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s.",
1811 ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06001812 }
1813 }
1814 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001815 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001816 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001817 std::stringstream ss;
1818 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1819 << "] do not match";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001820 skip |=
1821 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1822 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001823 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001824 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001825
Dave Houltonf5217612018-02-02 16:18:52 -07001826 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1827 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
1828 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1829 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1830 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001831 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00112, "IMAGE", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07001832 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001833 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001834
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001835 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001836 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001837 std::stringstream ss;
1838 ss << "vkCmdCopyImage: pRegion[" << i
1839 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1840 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001841 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011c, "IMAGE", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001842 }
1843
1844 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001845 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001846 std::stringstream ss;
1847 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1848 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001849 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011e, "IMAGE", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001850 }
1851
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001852 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001853 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1854 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001855 std::stringstream ss;
1856 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1857 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001858 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600150, "IMAGE", "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001859 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001860
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001861 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1862 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001863 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1864 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001865 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1866 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001867 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a60014e, "IMAGE", "%s.", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001868 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001869
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001870 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001871 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001872 std::stringstream ss;
1873 ss << "vkCmdCopyImage: pRegions[" << i
1874 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1875 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001876 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d40, "IMAGE", "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001877 }
Dave Houltonee281a52017-12-08 13:51:02 -07001878 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001879 std::stringstream ss;
1880 ss << "vkCmdCopyImage: pRegions[" << i
1881 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1882 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001883 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d42, "IMAGE", "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001884 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001885
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001886 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1887 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001888 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001889 std::stringstream ss;
1890 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001891 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001892 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001893 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d44, "IMAGE", "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001894 }
Dave Houltonee281a52017-12-08 13:51:02 -07001895 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001896 std::stringstream ss;
1897 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001898 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001899 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001900 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000d46, "IMAGE", "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001901 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001902
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001903 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1904 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1905 // 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 -07001906 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1907 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001908 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001909 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1910 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1911 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1912 << " ] exceeds the source image dimensions";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001913 skip |=
1914 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1915 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f4, "IMAGE", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001916 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001917
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001918 // 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 -07001919 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1920 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001921 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001922 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
1923 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
1924 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
1925 << " ] exceeds the destination image dimensions";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001926 skip |=
1927 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1928 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f6, "IMAGE", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001929 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001930 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001931
Dave Houltonfc1a4052017-04-27 14:32:45 -06001932 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07001933 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1934 if (slice_override) src_copy_extent.depth = depth_slices;
1935 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001936 if (extent_check & x_bit) {
1937 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 -06001938 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00120, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001939 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001940 "width [%1d].",
1941 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001942 }
1943
1944 if (extent_check & y_bit) {
1945 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 -06001946 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00122, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001947 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001948 "height [%1d].",
1949 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001950 }
1951 if (extent_check & z_bit) {
1952 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 -06001953 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00126, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001954 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001955 "depth [%1d].",
1956 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 }
1958
Dave Houltonee281a52017-12-08 13:51:02 -07001959 // Adjust dest extent if necessary
1960 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1961 if (slice_override) dst_copy_extent.depth = depth_slices;
1962
1963 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964 if (extent_check & x_bit) {
1965 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 -06001966 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012c, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001967 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001968 "width [%1d].",
1969 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001970 }
1971 if (extent_check & y_bit) {
1972 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 -06001973 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012e, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001974 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001975 "height [%1d].",
1976 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
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_09c00132, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001981 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001982 "depth [%1d].",
1983 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001984 }
1985
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001986 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1987 // must not overlap in memory
1988 if (src_image_state->image == dst_image_state->image) {
1989 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07001990 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
1991 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001992 std::stringstream ss;
1993 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1994 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001995 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f8, "IMAGE", "%s.",
1996 ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001997 }
1998 }
1999 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002000 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002001
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002002 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2003 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2004 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002005 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002006 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2007 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002008 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2009 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002010 }
2011 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002012 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2013 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002014 if (srcSize != destSize) {
2015 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2016 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002017 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_1900010e, "IMAGE", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002018 }
2019 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002020
Dave Houlton33c22b72017-02-28 13:16:02 -07002021 // Source and dest image sample counts must match
2022 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2023 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2024 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002025 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000110, "IMAGE", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002026 }
2027
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002028 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2029 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002030 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002031 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002032 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002033 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002034 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002035 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002036 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002037 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002038 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002039 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002040 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002041 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002042 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002043 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002044 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002045 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2046 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002047 }
2048
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002049 return skip;
2050}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002051
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002052void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002053 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2054 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2055 // Make sure that all image slices are updated to correct layout
2056 for (uint32_t i = 0; i < region_count; ++i) {
2057 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2058 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2059 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002060 // Update bindings between images and cmd buffer
2061 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2062 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002063 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002064 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002065 function = [=]() {
2066 SetImageMemoryValid(device_data, dst_image_state, true);
2067 return false;
2068 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002069 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002070}
2071
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002072// Returns true if sub_rect is entirely contained within rect
2073static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2074 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2075 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2076 return false;
2077 return true;
2078}
2079
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002080bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2081 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002082 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002083 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2084
2085 bool skip = false;
2086 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002087 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2088 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002089 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002090 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002091 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002092 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2093 // 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 -07002094 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2095 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002096 skip |= log_msg(
2097 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2098 HandleToUint64(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
2099 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2100 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2101 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002102 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002103 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002104 }
2105
2106 // Validate that attachment is in reference list of active subpass
2107 if (cb_node->activeRenderPass) {
2108 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2109 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002110 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002111
2112 for (uint32_t i = 0; i < attachmentCount; i++) {
2113 auto clear_desc = &pAttachments[i];
2114 VkImageView image_view = VK_NULL_HANDLE;
2115
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002116 if (0 == clear_desc->aspectMask) {
2117 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002118 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c03, "IMAGE", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002119 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2120 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002121 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00028, "IMAGE", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002122 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002123 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002124 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2125 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_1860001e, "DS",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002126 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d.",
2127 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002128 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2129 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002130 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer), __LINE__,
2131 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002132 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2133 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002134 } else {
2135 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002136 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002137 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002138 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2139 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2140 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002141 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002142 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002143 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00026, "IMAGE", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002144 }
2145 } else { // Must be depth and/or stencil
2146 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2147 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002148 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002149 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002150 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c01, "IMAGE", str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002151 }
2152 if (!subpass_desc->pDepthStencilAttachment ||
2153 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2154 skip |= log_msg(
2155 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002156 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002157 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002158 } else {
2159 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2160 }
2161 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002162 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002163 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002164 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002165 // The rectangular region specified by a given element of pRects must be contained within the render area of
2166 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002167 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2168 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2169 skip |=
2170 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 -06002171 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002172 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002173 "the current render pass instance.",
2174 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002175 }
2176 } else {
2177 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2178 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2179 return log_msg(
2180 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2181 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
2182 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002183 "the current render pass instance.",
2184 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002185 }
2186 return false;
2187 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002188 }
2189 // The layers specified by a given element of pRects must be contained within every attachment that
2190 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002191 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002192 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2193 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002194 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2195 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600022, "DS",
2196 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002197 "of pAttachment[%d].",
2198 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002199 }
2200 }
2201 }
2202 }
2203 }
2204 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002205}
2206
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002207bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002208 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002209 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002210 bool skip = false;
2211 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002212 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2213 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2214 skip |=
2215 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002216 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002217 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002218
2219 // For each region, the number of layers in the image subresource should not be zero
2220 // For each region, src and dest image aspect must be color only
2221 for (uint32_t i = 0; i < regionCount; i++) {
2222 if (pRegions[i].srcSubresource.layerCount == 0) {
2223 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002224 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 +02002225 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002226 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002227 if (pRegions[i].dstSubresource.layerCount == 0) {
2228 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002229 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 +02002230 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002231 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002232 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2233 skip |= log_msg(
2234 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002235 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200216, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002236 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002237 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002238 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2239 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2240 char const str[] =
2241 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2242 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002243 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200214, "IMAGE", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002244 }
2245 }
2246
2247 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2248 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002249 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 +02002250 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002251 }
2252 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2253 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002254 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 +02002255 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002256 }
2257 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2258 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2259 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002260 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800202, "IMAGE", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002261 }
2262 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2263 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2264 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002265 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800206, "IMAGE", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002266 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002267 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002268 } else {
2269 assert(0);
2270 }
2271 return skip;
2272}
2273
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002274void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2275 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002276 // Update bindings between images and cmd buffer
2277 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2278 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2279
2280 std::function<bool()> function = [=]() {
2281 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2282 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002283 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002284 function = [=]() {
2285 SetImageMemoryValid(device_data, dst_image_state, true);
2286 return false;
2287 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002288 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002289}
2290
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002291bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002292 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2293 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002294 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2295
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002296 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002297 if (cb_node) {
2298 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2299 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002300 if (cb_node && src_image_state && dst_image_state) {
2301 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002302 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002303 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002304 VALIDATION_ERROR_184001d4);
2305 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2306 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2307 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2308 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2309 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2310 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2311 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002312 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002313 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002314 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002315
Dave Houlton33c2d252017-06-09 17:08:32 -06002316 VkFormat src_format = src_image_state->createInfo.format;
2317 VkFormat dst_format = dst_image_state->createInfo.format;
2318 VkImageType src_type = src_image_state->createInfo.imageType;
2319 VkImageType dst_type = dst_image_state->createInfo.imageType;
2320
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002321 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002322 VkImageTiling tiling = src_image_state->createInfo.tiling;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002323 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002324 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2325 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2326 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b4, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002327 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature.",
2328 string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002329 }
2330
2331 if ((VK_FILTER_LINEAR == filter) &&
2332 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002333 skip |=
2334 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2335 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d6, "IMAGE",
2336 "vkCmdBlitImage: source image format %s does not support linear filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002337 }
2338
2339 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2340 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002341 skip |=
2342 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2343 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d8, "IMAGE",
2344 "vkCmdBlitImage: source image format %s does not support cubic filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002345 }
2346
2347 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2348 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2349 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001da, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002350 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002351 }
2352
2353 props = GetFormatProperties(device_data, dst_format);
2354 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002355 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002356 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002357 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2358 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001be, "IMAGE",
2359 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature.",
2360 string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002361 }
2362
2363 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2364 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2366 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001c8, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002367 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002368 }
2369
2370 // Validate consistency for unsigned formats
2371 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2372 std::stringstream ss;
2373 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2374 << "the other one must also have unsigned integer format. "
2375 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2376 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002377 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001cc, "IMAGE", "%s.",
2378 ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002379 }
2380
2381 // Validate consistency for signed formats
2382 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2383 std::stringstream ss;
2384 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2385 << "the other one must also have signed integer format. "
2386 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2387 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002388 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ca, "IMAGE", "%s.",
2389 ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002390 }
2391
2392 // Validate filter for Depth/Stencil formats
2393 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2394 std::stringstream ss;
2395 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2396 << "then filter must be VK_FILTER_NEAREST.";
2397 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002398 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d0, "IMAGE", "%s.",
2399 ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002400 }
2401
2402 // Validate aspect bits and formats for depth/stencil images
2403 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2404 if (src_format != dst_format) {
2405 std::stringstream ss;
2406 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2407 << "stencil, the other one must have exactly the same format. "
2408 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2409 << string_VkFormat(dst_format);
2410 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002411 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ce, "IMAGE", "%s.",
2412 ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002413 }
2414
2415#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2416 for (uint32_t i = 0; i < regionCount; i++) {
2417 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2418
2419 if (FormatIsDepthAndStencil(src_format)) {
2420 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2421 std::stringstream ss;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002422 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of VK_IMAGE_ASPECT_DEPTH_BIT "
Dave Houlton33c2d252017-06-09 17:08:32 -06002423 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2425 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2426 "%s", ss.str().c_str());
2427 }
2428 }
2429 else if (FormatIsStencilOnly(src_format)) {
2430 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2431 std::stringstream ss;
2432 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2433 << "set in both the srcImage and dstImage";
2434 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2435 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2436 "%s", ss.str().c_str());
2437 }
2438 }
2439 else if (FormatIsDepthOnly(src_format)) {
2440 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2441 std::stringstream ss;
2442 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2443 << "set in both the srcImage and dstImage";
2444 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2445 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2446 "%s", ss.str().c_str());
2447 }
2448 }
2449 }
2450#endif
2451 } // Depth or Stencil
2452
2453 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002454 for (uint32_t i = 0; i < region_count; i++) {
2455 const VkImageBlit rgn = regions[i];
2456 bool hit_error = false;
2457 skip |=
2458 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2459 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2460 skip |=
2461 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2462 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002463
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002464 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002465 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2466 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002467 std::stringstream ss;
2468 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2469 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 +02002470 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2471 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002472 }
Dave Houlton48989f32017-05-26 15:01:46 -06002473 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2474 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002475 std::stringstream ss;
2476 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2477 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 +02002478 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2479 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002480 }
Dave Houlton48989f32017-05-26 15:01:46 -06002481 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002482 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2483 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 +02002484 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002485 }
Dave Houlton48989f32017-05-26 15:01:46 -06002486 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002487 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2488 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 +02002489 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002490 }
2491
2492 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002493 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002494 skip |=
2495 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 -06002496 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001de, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002497 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002498 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002499
Dave Houlton48989f32017-05-26 15:01:46 -06002500 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002501 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 -06002502 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001dc, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002503 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002504 }
Dave Houlton48989f32017-05-26 15:01:46 -06002505
Dave Houlton33c2d252017-06-09 17:08:32 -06002506 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2507 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2508 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e2, "IMAGE",
2509 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002510 "image format %s.",
2511 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002512 }
2513
2514 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2515 skip |= log_msg(
2516 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2517 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e4, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002518 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
2519 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002520 }
2521
Dave Houlton48989f32017-05-26 15:01:46 -06002522 // Validate source image offsets
2523 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002524 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002525 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2526 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2527 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ea, "IMAGE",
2528 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002529 "of (%1d, %1d). These must be (0, 1).",
2530 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002531 }
2532 }
2533
Dave Houlton33c2d252017-06-09 17:08:32 -06002534 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002535 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2536 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2537 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ee, "IMAGE",
2538 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002539 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
2540 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002541 }
2542 }
2543
Dave Houlton33c2d252017-06-09 17:08:32 -06002544 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002545 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2546 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002547 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002548 skip |=
2549 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2550 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e6, "IMAGE",
2551 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
2552 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002553 }
2554 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2555 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002556 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002557 skip |= log_msg(
2558 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2559 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e8, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002560 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
2561 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002562 }
2563 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2564 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002565 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002566 skip |=
2567 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2568 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ec, "IMAGE",
2569 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
2570 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002571 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002572 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2573 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2574 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002575 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d.", i,
2576 rgn.srcSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002577 } else if (oob) {
2578 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2579 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002580 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06002581 }
Dave Houlton48989f32017-05-26 15:01:46 -06002582
2583 // Validate dest image offsets
2584 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002585 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002586 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2587 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2588 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f4, "IMAGE",
2589 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002590 "(%1d, %1d). These must be (0, 1).",
2591 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002592 }
2593 }
2594
Dave Houlton33c2d252017-06-09 17:08:32 -06002595 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002596 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2597 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2598 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f8, "IMAGE",
2599 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002600 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
2601 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002602 }
2603 }
2604
Dave Houlton33c2d252017-06-09 17:08:32 -06002605 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002606 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2607 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002608 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002609 skip |=
2610 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2611 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f0, "IMAGE",
2612 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
2613 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002614 }
2615 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2616 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002617 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002618 skip |= log_msg(
2619 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2620 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f2, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002621 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
2622 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002623 }
2624 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2625 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002626 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002627 skip |=
2628 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2629 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f6, "IMAGE",
2630 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
2631 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002632 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002633 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002634 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 -06002635 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002636 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d.", i,
2637 rgn.dstSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002638 } else if (oob) {
2639 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2640 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002641 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002642 }
2643
Dave Houlton33c2d252017-06-09 17:08:32 -06002644 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2645 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2646 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2647 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2648 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e0, "IMAGE",
2649 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002650 "layerCount other than 1.",
2651 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002652 }
2653 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002654 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002655 } else {
2656 assert(0);
2657 }
2658 return skip;
2659}
2660
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002661void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002662 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2663 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2664 // Make sure that all image slices are updated to correct layout
2665 for (uint32_t i = 0; i < region_count; ++i) {
2666 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2667 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2668 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002669 // Update bindings between images and cmd buffer
2670 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2671 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2672
2673 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002674 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002675 function = [=]() {
2676 SetImageMemoryValid(device_data, dst_image_state, true);
2677 return false;
2678 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002679 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002680}
2681
Tony Barbourdf013b92017-01-25 12:53:48 -07002682// This validates that the initial layout specified in the command buffer for
2683// the IMAGE is the same
2684// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002685bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002686 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2687 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002688 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002689 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002690 for (auto cb_image_data : pCB->imageLayoutMap) {
2691 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002692
Dave Houltonb3f4b282018-02-22 16:25:16 -07002693 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2694 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002695 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2696 // TODO: Set memory invalid which is in mem_tracker currently
2697 } else if (imageLayout != cb_image_data.second.initialLayout) {
2698 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002699 skip |= log_msg(
2700 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2701 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2702 "Cannot submit cmd buffer using image (0x%" PRIx64
2703 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2704 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2705 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2706 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002707 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002708 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2709 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002710 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002711 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2712 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002713 }
2714 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002715 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002716 }
2717 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002718 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002719}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002720
Tony Barbourdf013b92017-01-25 12:53:48 -07002721void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2722 for (auto cb_image_data : pCB->imageLayoutMap) {
2723 VkImageLayout imageLayout;
2724 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2725 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2726 }
2727}
2728
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002729// Print readable FlagBits in FlagMask
2730static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2731 std::string result;
2732 std::string separator;
2733
2734 if (accessMask == 0) {
2735 result = "[None]";
2736 } else {
2737 result = "[";
2738 for (auto i = 0; i < 32; i++) {
2739 if (accessMask & (1 << i)) {
2740 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2741 separator = " | ";
2742 }
2743 }
2744 result = result + "]";
2745 }
2746 return result;
2747}
2748
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002749// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2750// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002751// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002752static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2753 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2754 const char *type) {
2755 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2756 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002757
2758 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2759 if (accessMask & ~(required_bit | optional_bits)) {
2760 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002761 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 +02002762 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002763 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2764 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002765 }
2766 } else {
2767 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002768 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 +02002769 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002770 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
2771 "has previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002772 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2773 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002774 } else {
2775 std::string opt_bits;
2776 if (optional_bits != 0) {
2777 std::stringstream ss;
2778 ss << optional_bits;
2779 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2780 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002781 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 +02002782 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002783 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
2784 "previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002785 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2786 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002787 }
2788 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002789 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002790}
2791
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002792// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002793// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2794// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002795bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002796 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2797 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002798 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2799 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2800 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2801 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskieb9e73f2017-04-13 10:06:48 -06002802 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002803 VALIDATION_ERROR_12200688, "DS", "Cannot clear attachment %d with invalid first layout %s.", attachment,
2804 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002805 }
2806 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002807 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002808}
2809
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002810bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2811 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002812 bool skip = false;
2813
Jason Ekstranda1906302017-12-03 20:16:32 -08002814 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2815 VkFormat format = pCreateInfo->pAttachments[i].format;
2816 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2817 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2818 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Tobin Ehlis73836462018-02-13 09:35:47 -07002819 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2820 DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002821 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
2822 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2823 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2824 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002825 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07002826 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Tobin Ehlis73836462018-02-13 09:35:47 -07002827 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2828 DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002829 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
2830 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2831 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2832 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002833 }
2834 }
2835 }
2836
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002837 // Track when we're observing the first use of an attachment
2838 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2839 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2840 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002841
2842 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2843 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2844 auto attach_index = subpass.pInputAttachments[j].attachment;
2845 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2846
2847 switch (subpass.pInputAttachments[j].layout) {
2848 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2849 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2850 // These are ideal.
2851 break;
2852
2853 case VK_IMAGE_LAYOUT_GENERAL:
2854 // May not be optimal. TODO: reconsider this warning based on other constraints.
2855 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2856 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2857 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2858 break;
2859
2860 default:
2861 // No other layouts are acceptable
2862 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2863 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2864 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2865 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2866 }
2867
2868 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2869 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2870 subpass.pDepthStencilAttachment->attachment == attach_index &&
2871 subpass.pDepthStencilAttachment->layout != layout;
2872 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2873 found_layout_mismatch =
2874 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2875 }
2876 if (found_layout_mismatch) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002877 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2878 VALIDATION_ERROR_140006ae, "DS",
2879 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002880 "depth/color attachment with a different layout.",
2881 i, j, attach_index, layout);
Cort Stratton7547f772017-05-04 15:18:52 -07002882 }
2883
2884 if (attach_first_use[attach_index]) {
2885 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2886 pCreateInfo->pAttachments[attach_index]);
2887
2888 bool used_as_depth =
2889 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2890 bool used_as_color = false;
2891 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2892 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2893 }
2894 if (!used_as_depth && !used_as_color &&
2895 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2896 skip |= log_msg(
2897 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002898 VALIDATION_ERROR_1400069c, "DS",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002899 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
2900 attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07002901 }
2902 }
2903 attach_first_use[attach_index] = false;
2904 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002905 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2906 auto attach_index = subpass.pColorAttachments[j].attachment;
2907 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2908
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002909 // TODO: Need a way to validate shared presentable images here, currently just allowing
2910 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2911 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002912 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002913 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002914 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002915 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2916 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002917 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002918
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002919 case VK_IMAGE_LAYOUT_GENERAL:
2920 // May not be optimal; TODO: reconsider this warning based on other constraints?
2921 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2922 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2923 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2924 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002925
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002926 default:
2927 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2928 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2929 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2930 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002931 }
2932
2933 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002934 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2935 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002936 }
2937 attach_first_use[attach_index] = false;
2938 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06002939
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002940 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2941 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002942 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2943 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2944 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06002945 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06002946
Dave Houltona9df0ce2018-02-07 10:51:23 -07002947 case VK_IMAGE_LAYOUT_GENERAL:
2948 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2949 // doing a bunch of transitions.
2950 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2951 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2952 "GENERAL layout for depth attachment may not give optimal performance.");
2953 break;
2954
2955 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
2956 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
2957 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
2958 break;
2959 } else {
2960 // Intentionally fall through to generic error message
2961 }
2962
2963 default:
2964 // No other layouts are acceptable
2965 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2966 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2967 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2968 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2969 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002970 }
2971
2972 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2973 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002974 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2975 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002976 }
2977 attach_first_use[attach_index] = false;
2978 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002979 }
2980 return skip;
2981}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002982
2983// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002984bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2985 VkDeviceSize offset, VkDeviceSize end_offset) {
2986 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2987 bool skip = false;
2988 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2989 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002990 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2991 for (auto image_handle : mem_info->bound_images) {
2992 auto img_it = mem_info->bound_ranges.find(image_handle);
2993 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002994 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002995 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002996 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002997 for (auto layout : layouts) {
2998 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002999 skip |=
3000 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
3001 HandleToUint64(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003002 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3003 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003004 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003005 }
3006 }
3007 }
3008 }
3009 }
3010 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003011 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003012}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003013
3014// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3015// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003016static 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 -06003017 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003018 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003019
3020 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003021 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003022 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003023 if (strict) {
3024 correct_usage = ((actual & desired) == desired);
3025 } else {
3026 correct_usage = ((actual & desired) != 0);
3027 }
3028 if (!correct_usage) {
3029 if (msgCode == -1) {
3030 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003031 skip =
3032 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__,
3033 MEMTRACK_INVALID_USAGE_FLAG, "MEM",
3034 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3035 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003036 } else {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003037 skip = log_msg(
3038 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__, msgCode, "MEM",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003039 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3040 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003041 }
3042 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003043 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003044}
3045
3046// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3047// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003048bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003049 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003050 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3051 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003052}
3053
3054// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3055// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003056bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003057 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003058 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3059 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003060}
3061
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003062bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003063 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003064 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3065
Chris Forbese0f511c2017-06-14 12:38:01 -07003066 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003067
3068 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
3069 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 -06003070 VALIDATION_ERROR_01400726, "DS",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003071 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003072 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003073 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003074
3075 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003076 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3077 VALIDATION_ERROR_01400728, "DS",
3078 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003079 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003080 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003081
3082 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003083 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3084 VALIDATION_ERROR_0140072a, "DS",
3085 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003086 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003087 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003088 return skip;
3089}
3090
3091void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3092 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3093 GetBufferMap(device_data)
3094 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3095}
3096
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003097bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3098 bool skip = false;
3099 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003100 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3101 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003102 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003103 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3104 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003105 skip |= ValidateBufferUsageFlags(
3106 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 -06003107 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003108 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003109 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003110}
3111
3112void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3113 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3114}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003115
3116// For the given format verify that the aspect masks make sense
3117bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3118 const char *func_name) {
3119 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3120 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003121 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003122 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003123 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 -06003124 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003125 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003126 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003127 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 -06003128 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003129 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003130 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003131 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003132 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003133 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 -06003134 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003135 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003136 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3137 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003138 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003139 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 -06003140 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003141 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003142 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3143 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003144 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003145 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003146 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003147 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 -06003148 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003149 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003150 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003151 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003152 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003153 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003154 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003155 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003156 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003157 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003158 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003159 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003160 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003161 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 -06003162 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003163 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003164 }
3165 }
3166 return skip;
3167}
3168
Petr Krausffa94af2017-08-08 21:46:02 +02003169struct SubresourceRangeErrorCodes {
3170 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3171};
3172
3173bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3174 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3175 const char *image_layer_count_var_name, const uint64_t image_handle,
3176 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003177 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3178 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003179
3180 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003181 if (subresourceRange.baseMipLevel >= image_mip_count) {
3182 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3183 errorCodes.base_mip_err, "IMAGE",
3184 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003185 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3186 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003187 }
Petr Kraus4d718682017-05-18 03:38:41 +02003188
Petr Krausffa94af2017-08-08 21:46:02 +02003189 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3190 if (subresourceRange.levelCount == 0) {
3191 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003192 __LINE__, errorCodes.mip_count_err, "IMAGE", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003193 } else {
3194 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003195
Petr Krausffa94af2017-08-08 21:46:02 +02003196 if (necessary_mip_count > image_mip_count) {
3197 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3198 __LINE__, errorCodes.mip_count_err, "IMAGE",
3199 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003200 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003201 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003202 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003203 }
Petr Kraus4d718682017-05-18 03:38:41 +02003204 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003205 }
Petr Kraus4d718682017-05-18 03:38:41 +02003206
3207 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003208 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003209 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3210 errorCodes.base_layer_err, "IMAGE",
3211 "%s: %s.baseArrayLayer (= %" PRIu32
3212 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3213 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003214 }
Petr Kraus4d718682017-05-18 03:38:41 +02003215
Petr Krausffa94af2017-08-08 21:46:02 +02003216 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3217 if (subresourceRange.layerCount == 0) {
3218 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003219 __LINE__, errorCodes.layer_count_err, "IMAGE", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003220 } else {
3221 const uint64_t necessary_layer_count =
3222 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003223
Petr Krausffa94af2017-08-08 21:46:02 +02003224 if (necessary_layer_count > image_layer_count) {
3225 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3226 __LINE__, errorCodes.layer_count_err, "IMAGE",
3227 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003228 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003229 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003230 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003231 }
Petr Kraus4d718682017-05-18 03:38:41 +02003232 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003233 }
Petr Kraus4d718682017-05-18 03:38:41 +02003234
Mark Lobodzinski602de982017-02-09 11:01:33 -07003235 return skip;
3236}
3237
Petr Krausffa94af2017-08-08 21:46:02 +02003238bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3239 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3240 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3241 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3242 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3243 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3244
3245 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3246 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3247
3248 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3249 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003250 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00d6c;
Petr Krausffa94af2017-08-08 21:46:02 +02003251 subresourceRangeErrorCodes.base_layer_err =
3252 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3253 subresourceRangeErrorCodes.layer_count_err =
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003254 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00d6e;
Petr Krausffa94af2017-08-08 21:46:02 +02003255
3256 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3257 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3258 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3259}
3260
3261bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3262 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3263 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3264 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003265 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800d38;
Petr Krausffa94af2017-08-08 21:46:02 +02003266 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003267 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800d3a;
Petr Krausffa94af2017-08-08 21:46:02 +02003268
3269 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3270 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3271 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3272}
3273
3274bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3275 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3276 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3277 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003278 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00d3c;
Petr Krausffa94af2017-08-08 21:46:02 +02003279 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003280 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00d3e;
Petr Krausffa94af2017-08-08 21:46:02 +02003281
3282 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3283 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3284 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3285}
3286
3287bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3288 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3289 const char *param_name) {
3290 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3291 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003292 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000d78;
Petr Krausffa94af2017-08-08 21:46:02 +02003293 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003294 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000d7a;
Petr Krausffa94af2017-08-08 21:46:02 +02003295
3296 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3297 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3298 subresourceRangeErrorCodes);
3299}
3300
Mark Lobodzinski602de982017-02-09 11:01:33 -07003301bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3302 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3303 bool skip = false;
3304 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3305 if (image_state) {
3306 skip |= ValidateImageUsageFlags(
3307 device_data, image_state,
3308 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houltona9df0ce2018-02-07 10:51:23 -07003309 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003310 false, -1, "vkCreateImageView()",
3311 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3312 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003313 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003314 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003315 skip |= ValidateCreateImageViewSubresourceRange(
3316 device_data, image_state,
3317 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3318 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003319
3320 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3321 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003322 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3323 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003324 VkFormat view_format = create_info->format;
3325 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003326 VkImageType image_type = image_state->createInfo.imageType;
3327 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003328
3329 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3330 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003331 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3332 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3333 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3334 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3335 std::stringstream ss;
3336 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3337 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3338 << ") format " << string_VkFormat(image_format)
3339 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3340 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3341 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003342 __LINE__, VALIDATION_ERROR_0ac007f4, "IMAGE", "%s", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06003343 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003344 }
3345 } else {
3346 // Format MUST be IDENTICAL to the format the image was created with
3347 if (image_format != view_format) {
3348 std::stringstream ss;
3349 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003350 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003351 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003352 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003353 VALIDATION_ERROR_0ac007f6, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07003354 }
3355 }
3356
3357 // Validate correct image aspect bits for desired formats and format consistency
3358 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003359
3360 switch (image_type) {
3361 case VK_IMAGE_TYPE_1D:
3362 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3363 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3364 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003365 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3366 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003367 }
3368 break;
3369 case VK_IMAGE_TYPE_2D:
3370 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3371 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3372 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3373 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3374 __LINE__, VALIDATION_ERROR_0ac007d6, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003375 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3376 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003377 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3378 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3379 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003380 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3381 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003382 }
3383 }
3384 break;
3385 case VK_IMAGE_TYPE_3D:
3386 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3387 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3388 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3389 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003390 skip |=
3391 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3392 __LINE__, VALIDATION_ERROR_0ac007da, "IMAGE",
3393 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3394 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003395 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3396 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003397 skip |=
3398 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3399 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3400 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3401 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003402 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
3403 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003404 }
3405 } else {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003406 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3407 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3408 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3409 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003410 }
3411 }
3412 } else {
3413 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3414 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3415 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003416 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3417 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003418 }
3419 }
3420 break;
3421 default:
3422 break;
3423 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003424
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003425 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003426 bool check_tiling_features = false;
3427 VkFormatFeatureFlags tiling_features = 0;
3428 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3429 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3430 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3431 };
3432 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3433 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3434 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3435 };
3436 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3437 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003438 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003439 error_codes = linear_error_codes;
3440 check_tiling_features = true;
3441 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003442 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003443 error_codes = optimal_error_codes;
3444 check_tiling_features = true;
3445 }
3446
3447 if (check_tiling_features) {
3448 if (tiling_features == 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003449 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3450 error_codes[0], "IMAGE",
3451 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set.",
3452 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003453 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003454 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3455 error_codes[1], "IMAGE",
3456 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3457 "VK_IMAGE_USAGE_SAMPLED_BIT flags set.",
3458 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003459 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003460 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3461 error_codes[2], "IMAGE",
3462 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3463 "VK_IMAGE_USAGE_STORAGE_BIT flags set.",
3464 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003465 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3466 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003467 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3468 error_codes[3], "IMAGE",
3469 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3470 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set.",
3471 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003472 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3473 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003474 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3475 error_codes[4], "IMAGE",
3476 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3477 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set.",
3478 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003479 }
3480 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003481 }
3482 return skip;
3483}
3484
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003485void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3486 auto image_view_map = GetImageViewMap(device_data);
3487 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3488
3489 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003490 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003491 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3492 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003493}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003494
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003495bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3496 BUFFER_STATE *dst_buffer_state) {
3497 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003498 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3499 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003500 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003501 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3502 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3503 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3504 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003505 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003506 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003507 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003508 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003509 return skip;
3510}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003511
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003512void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3513 BUFFER_STATE *dst_buffer_state) {
3514 // Update bindings between buffers and cmd buffer
3515 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3516 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3517
3518 std::function<bool()> function = [=]() {
3519 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3520 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003521 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003522 function = [=]() {
3523 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3524 return false;
3525 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003526 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003527}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003528
3529static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3530 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3531 bool skip = false;
3532 auto buffer_state = GetBufferState(device_data, buffer);
3533 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003534 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 +01003535 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS", "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
3536 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003537 } else {
3538 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003539 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 -06003540 HandleToUint64(buffer), __LINE__, VALIDATION_ERROR_23c00734, "DS",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003541 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003542 }
3543 }
3544 return skip;
3545}
3546
3547bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3548 VK_OBJECT *obj_struct) {
3549 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003550 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003551 if (GetDisables(device_data)->destroy_image_view) return false;
3552 bool skip = false;
3553 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003554 skip |=
3555 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003556 }
3557 return skip;
3558}
3559
3560void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3561 VK_OBJECT obj_struct) {
3562 // Any bound cmd buffers are now invalid
3563 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3564 (*GetImageViewMap(device_data)).erase(image_view);
3565}
3566
3567bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3568 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003569 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003570 if (GetDisables(device_data)->destroy_buffer) return false;
3571 bool skip = false;
3572 if (*buffer_state) {
3573 skip |= validateIdleBuffer(device_data, buffer);
3574 }
3575 return skip;
3576}
3577
3578void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3579 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3580 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3581 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3582 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003583 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003584 }
3585 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003586 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003587 GetBufferMap(device_data)->erase(buffer_state->buffer);
3588}
3589
3590bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3591 VK_OBJECT *obj_struct) {
3592 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003593 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003594 if (GetDisables(device_data)->destroy_buffer_view) return false;
3595 bool skip = false;
3596 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003597 skip |=
3598 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003599 }
3600 return skip;
3601}
3602
3603void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3604 VK_OBJECT obj_struct) {
3605 // Any bound cmd buffers are now invalid
3606 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3607 GetBufferViewMap(device_data)->erase(buffer_view);
3608}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003609
3610bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3611 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003612 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003613 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003614 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003615 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3616 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003617 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003618 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003619 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003620 return skip;
3621}
3622
3623void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3624 std::function<bool()> function = [=]() {
3625 SetBufferMemoryValid(device_data, buffer_state, true);
3626 return false;
3627 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003628 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003629 // Update bindings between buffer and cmd buffer
3630 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003631}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003632
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003633bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3634 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003635 bool skip = false;
3636
3637 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003638 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3639 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003640 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 -06003641 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160018e, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003642 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003643 "and 1, respectively.",
3644 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003645 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003646 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003647
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003648 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3649 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003650 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 -06003651 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600192, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003652 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003653 "must be 0 and 1, respectively.",
3654 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003655 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003656 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003657
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003658 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3659 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003660 skip |=
3661 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3662 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001aa, "IMAGE",
3663 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
3664 "For 3D images these must be 0 and 1, respectively.",
3665 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003666 }
3667 }
3668
3669 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3670 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003671 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003672 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003673 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 -06003674 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600182, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003675 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003676 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
3677 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003678 }
3679
3680 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003681 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003682 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 -06003683 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600184, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003684 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
3685 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003686 }
3687
3688 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3689 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003690 skip |=
3691 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3692 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600186, "IMAGE",
3693 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
3694 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003695 }
3696
3697 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3698 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3699 skip |= log_msg(
3700 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003701 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600188, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003702 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
3703 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003704 }
3705
3706 // subresource aspectMask must have exactly 1 bit set
3707 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3708 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3709 if (aspect_mask_bits.count() != 1) {
3710 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 -06003711 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a8, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003712 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003713 }
3714
3715 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003716 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003717 skip |= log_msg(
3718 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003719 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a6, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003720 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
3721 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003722 }
3723
3724 // Checks that apply only to compressed images
3725 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3726 // reserves a place for these compressed image checks. This block of code could move there once the image
3727 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003728 if (FormatIsCompressed(image_state->createInfo.format)) {
3729 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003730
3731 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003732 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003733 skip |= log_msg(
3734 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003735 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600196, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003736 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
3737 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003738 }
3739
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003740 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003741 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003742 skip |= log_msg(
3743 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3744 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600198, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003745 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
3746 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003747 }
3748
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003749 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003750 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3751 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3752 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003753 skip |=
3754 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3755 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019a, "IMAGE",
3756 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3757 "width & height (%d, %d)..",
3758 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003759 }
3760
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003761 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003762 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3763 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003764 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3765 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019c, "IMAGE",
3766 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3767 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
3768 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003769 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003770
3771 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003772 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003773 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003774 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3775 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 -06003776 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019e, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003777 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003778 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003779 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003780 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07003781 }
3782
3783 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003784 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003785 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3786 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 -06003787 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a0, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003788 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003789 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003790 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003791 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07003792 }
3793
3794 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003795 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003796 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3797 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 -06003798 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a2, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003799 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003800 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003801 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003802 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07003803 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003804 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003805 }
3806
3807 return skip;
3808}
3809
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003810static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3811 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003812 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003813 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003814
3815 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003816 VkExtent3D extent = pRegions[i].imageExtent;
3817 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003818
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003819 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3820 {
3821 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3822 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
3823 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
3824 extent.height, extent.depth);
3825 }
3826
3827 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3828
3829 // 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 -06003830 if (FormatIsCompressed(image_info->format)) {
3831 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003832 if (image_extent.width % block_extent.width) {
3833 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3834 }
3835 if (image_extent.height % block_extent.height) {
3836 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3837 }
3838 if (image_extent.depth % block_extent.depth) {
3839 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3840 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003841 }
3842
Dave Houltonfc1a4052017-04-27 14:32:45 -06003843 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003844 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003845 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003846 }
3847 }
3848
3849 return skip;
3850}
3851
Chris Forbese8ba09a2017-06-01 17:39:02 -07003852static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003853 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3854 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003855 bool skip = false;
3856
3857 VkDeviceSize buffer_size = buff_state->createInfo.size;
3858
3859 for (uint32_t i = 0; i < regionCount; i++) {
3860 VkExtent3D copy_extent = pRegions[i].imageExtent;
3861
3862 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3863 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003864 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003865
Dave Houltonf3229d52017-02-21 15:59:08 -07003866 // Handle special buffer packing rules for specific depth/stencil formats
3867 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003868 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003869 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3870 switch (image_state->createInfo.format) {
3871 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003872 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003873 break;
3874 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003875 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003876 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003877 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003878 case VK_FORMAT_D24_UNORM_S8_UINT:
3879 unit_size = 4;
3880 break;
3881 default:
3882 break;
3883 }
3884 }
3885
Dave Houlton1d2022c2017-03-29 11:43:58 -06003886 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003887 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003888 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003889 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3890 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3891
3892 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3893 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3894 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003895 }
3896
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003897 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3898 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3899 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003900 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003901 } else {
3902 // Calculate buffer offset of final copied byte, + 1.
3903 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3904 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3905 max_buffer_offset *= unit_size; // convert to bytes
3906 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003907
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003908 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003909 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3910 (uint64_t)0, __LINE__, msg_code, "IMAGE",
3911 "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003912 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003913 }
3914 }
3915
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003916 return skip;
3917}
3918
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003919bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003920 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003921 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003922 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3923 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
3924
3925 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07003926 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003927
3928 // Command pool must support graphics, compute, or transfer operations
3929 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3930
3931 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3932 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3933 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 -06003934 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_19202415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003935 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003936 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003937 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003938 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003939 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07003940 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06003941 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003942
3943 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003944 VALIDATION_ERROR_19200178);
3945 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
3946 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003947
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003948 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003949 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003950 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003951 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3952 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
3953 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003954 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003955 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003956 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
3957 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
3958 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003959 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003960 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003961 }
3962 return skip;
3963}
3964
3965void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003966 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
3967 VkImageLayout src_image_layout) {
3968 // Make sure that all image slices are updated to correct layout
3969 for (uint32_t i = 0; i < region_count; ++i) {
3970 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
3971 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003972 // Update bindings between buffer/image and cmd buffer
3973 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003974 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003975
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003976 std::function<bool()> function = [=]() {
3977 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
3978 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003979 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003980 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003981 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003982 return false;
3983 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003984 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003985}
3986
3987bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003988 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003989 const VkBufferImageCopy *pRegions, const char *func_name) {
3990 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3991 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
3992
3993 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07003994 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003995
3996 // Command pool must support graphics, compute, or transfer operations
3997 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3998 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3999 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4000 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 -06004001 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_18e02415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004002 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004003 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004004 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004005 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004006 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004007 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004008 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004009 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004010 VALIDATION_ERROR_18e00166);
4011 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4012 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4013 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4014 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4015 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004016 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004017 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004018 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004019 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004020 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4021 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4022 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004023 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4024 "vkCmdCopyBufferToImage()");
4025 }
4026 return skip;
4027}
4028
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004029void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004030 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4031 VkImageLayout dst_image_layout) {
4032 // Make sure that all image slices are updated to correct layout
4033 for (uint32_t i = 0; i < region_count; ++i) {
4034 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4035 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004036 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004037 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004038 std::function<bool()> function = [=]() {
4039 SetImageMemoryValid(device_data, dst_image_state, true);
4040 return false;
4041 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004042 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004043 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004044 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004045}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004046
4047bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4048 const auto report_data = core_validation::GetReportData(device_data);
4049 bool skip = false;
4050 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4051
Dave Houlton1d960ff2018-01-19 12:17:05 -07004052 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004053 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4054 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4055 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004056 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 -06004057 __LINE__, VALIDATION_ERROR_2a6007ca, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004058 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004059 }
4060
4061 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4062 if (!image_entry) {
4063 return skip;
4064 }
4065
Dave Houlton1d960ff2018-01-19 12:17:05 -07004066 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004067 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004068 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 -06004069 __LINE__, VALIDATION_ERROR_2a6007c8, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004070 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004071 }
4072
Dave Houlton1d960ff2018-01-19 12:17:05 -07004073 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004074 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004075 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 -07004076 __LINE__, VALIDATION_ERROR_2a600d68, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004077 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4078 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004079 }
4080
Dave Houlton1d960ff2018-01-19 12:17:05 -07004081 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004082 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004083 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4084 __LINE__, VALIDATION_ERROR_2a600d6a, "IMAGE",
4085 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4086 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004087 }
4088
Dave Houlton1d960ff2018-01-19 12:17:05 -07004089 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004090 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004091 if (FormatIsMultiplane(img_format)) {
4092 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4093 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4094 if (FormatPlaneCount(img_format) > 2u) {
4095 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4096 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4097 }
4098 if (sub_aspect != (sub_aspect & allowed_flags)) {
4099 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4100 HandleToUint64(image), __LINE__, vuid, "IMAGE",
4101 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004102 ") must be a single-plane specifier flag.",
4103 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004104 }
4105 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004106 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004107 skip |= log_msg(
4108 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), __LINE__,
4109 VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004110 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004111 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004112 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004113 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004114 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 -06004115 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004116 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004117 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004118 }
4119 }
4120 return skip;
4121}