blob: 4167e7a6e9a01277fbfbbd6c8dae8885b93e8779 [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
Petr Kraus4d718682017-05-18 03:38:41 +020025#include <inttypes.h>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070026#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020027#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070028
29#include "vk_enum_string_helper.h"
30#include "vk_layer_data.h"
31#include "vk_layer_utils.h"
32#include "vk_layer_logging.h"
33
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070034#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070035
Tobin Ehlis58c884f2017-02-08 12:15:27 -070036void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070037 auto it = pCB->imageLayoutMap.find(imgpair);
38 if (it != pCB->imageLayoutMap.end()) {
39 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070040 } else {
41 assert(imgpair.hasSubresource);
42 IMAGE_CMD_BUF_LAYOUT_NODE node;
43 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
44 node.initialLayout = layout;
45 }
46 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
47 }
48}
49template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070050void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070051 ImageSubresourcePair imgpair = {image, true, range};
52 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
53 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
54 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
55 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -070056 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
57 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
58 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
59 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
60 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070061}
62
63template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070064void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070065 VkImageAspectFlags aspectMask) {
66 if (imgpair.subresource.aspectMask & aspectMask) {
67 imgpair.subresource.aspectMask = aspectMask;
68 SetLayout(device_data, pObject, imgpair, layout);
69 }
70}
71
Tony Barbourdf013b92017-01-25 12:53:48 -070072// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070073void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
74 VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070075 auto it = imageLayoutMap.find(imgpair);
76 if (it != imageLayoutMap.end()) {
77 it->second.layout = layout; // Update
78 } else {
79 imageLayoutMap[imgpair].layout = layout; // Insert
80 }
Tony Barbourdf013b92017-01-25 12:53:48 -070081}
82
Tobin Ehlisc8266452017-04-07 12:20:30 -060083bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070084 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
85 const debug_report_data *report_data = core_validation::GetReportData(device_data);
86
87 if (!(imgpair.subresource.aspectMask & aspectMask)) {
88 return false;
89 }
90 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
91 imgpair.subresource.aspectMask = aspectMask;
92 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
93 if (imgsubIt == pCB->imageLayoutMap.end()) {
94 return false;
95 }
96 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +020097 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
98 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070099 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200100 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700101 string_VkImageLayout(imgsubIt->second.layout));
102 }
103 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200104 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
105 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700106 "Cannot query for VkImage 0x%" PRIx64
107 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200108 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700109 string_VkImageLayout(imgsubIt->second.initialLayout));
110 }
111 node = imgsubIt->second;
112 return true;
113}
114
Tobin Ehlisc8266452017-04-07 12:20:30 -0600115bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700116 const VkImageAspectFlags aspectMask) {
117 if (!(imgpair.subresource.aspectMask & aspectMask)) {
118 return false;
119 }
120 const debug_report_data *report_data = core_validation::GetReportData(device_data);
121 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
122 imgpair.subresource.aspectMask = aspectMask;
123 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
124 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
125 return false;
126 }
127 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200128 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
129 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700130 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200131 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700132 string_VkImageLayout(imgsubIt->second.layout));
133 }
134 layout = imgsubIt->second.layout;
135 return true;
136}
137
138// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600139bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700140 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
141 ImageSubresourcePair imgpair = {image, true, range};
142 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
143 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
144 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
145 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
146 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700147 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
148 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
149 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
150 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
151 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700152 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
153 imgpair = {image, false, VkImageSubresource()};
154 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
155 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
156 // TODO: This is ostensibly a find function but it changes state here
157 node = imgsubIt->second;
158 }
159 return true;
160}
161
162// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700163bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700164 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
165 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
166 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
167 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
168 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700169 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
170 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
171 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
172 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
173 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700174 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
175 imgpair = {imgpair.image, false, VkImageSubresource()};
176 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
177 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
178 layout = imgsubIt->second.layout;
179 }
180 return true;
181}
182
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700183bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700184 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
185 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700186 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700187 if (!image_state) return false;
188 bool ignoreGlobal = false;
189 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
190 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
191 ignoreGlobal = true;
192 }
193 for (auto imgsubpair : sub_data->second) {
194 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
195 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
196 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
197 layouts.push_back(img_data->second.layout);
198 }
199 }
200 return true;
201}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700202bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
203 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700204 if (!(imgpair.subresource.aspectMask & aspectMask)) {
205 return false;
206 }
207 imgpair.subresource.aspectMask = aspectMask;
208 auto imgsubIt = imageLayoutMap.find(imgpair);
209 if (imgsubIt == imageLayoutMap.end()) {
210 return false;
211 }
212 layout = imgsubIt->second.layout;
213 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700214}
Tony Barbourdf013b92017-01-25 12:53:48 -0700215
216// find layout in supplied map
Dave Houltonb3f4b282018-02-22 16:25:16 -0700217bool FindLayout(layer_data *device_data, const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
218 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700219 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
220 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
221 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
222 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
223 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700224 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
225 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
226 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
227 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
228 }
229 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700230 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
231 imgpair = {imgpair.image, false, VkImageSubresource()};
232 auto imgsubIt = imageLayoutMap.find(imgpair);
233 if (imgsubIt == imageLayoutMap.end()) return false;
234 layout = imgsubIt->second.layout;
235 }
236 return true;
237}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700238
239// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700240void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700241 VkImage &image = imgpair.image;
Dave Houltonb3f4b282018-02-22 16:25:16 -0700242 auto &lmap = (*core_validation::GetImageLayoutMap(device_data));
243 auto data = lmap.find(imgpair);
244 if (data != lmap.end()) {
245 data->second.layout = layout; // Update
246 } else {
247 lmap[imgpair].layout = layout; // Insert
248 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700249 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
250 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
251 if (subresource == image_subresources.end()) {
252 image_subresources.push_back(imgpair);
253 }
254}
255
256// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700257void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700258 auto it = pCB->imageLayoutMap.find(imgpair);
259 if (it != pCB->imageLayoutMap.end()) {
260 it->second = node; // Update
261 } else {
262 pCB->imageLayoutMap[imgpair] = node; // Insert
263 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700264}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600265// Set image layout for given VkImageSubresourceRange struct
266void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
267 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
268 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700269 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600270 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
271 uint32_t level = image_subresource_range.baseMipLevel + level_index;
272 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
273 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
274 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700275 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
276 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600277 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600278 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700279 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
280 }
281 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600282 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700283 }
284 }
285}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600286// Set image layout for given VkImageSubresourceLayers struct
287void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
288 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
289 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
290 VkImageSubresourceRange image_subresource_range;
291 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
292 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
293 image_subresource_range.layerCount = image_subresource_layers.layerCount;
294 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
295 image_subresource_range.levelCount = 1;
296 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
297}
298// Set image layout for all slices of an image view
299void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
300 auto view_state = GetImageViewState(device_data, imageView);
301 assert(view_state);
302
303 SetImageLayout(device_data, cb_node, GetImageState(device_data, view_state->create_info.image),
304 view_state->create_info.subresourceRange, layout);
305}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700306
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700307bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700308 const VkRenderPassBeginInfo *pRenderPassBegin,
309 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600310 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700311 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700312 auto const &framebufferInfo = framebuffer_state->createInfo;
313 const auto report_data = core_validation::GetReportData(device_data);
314 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600315 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200316 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -0700317 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700318 }
319 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
320 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700321 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700322 assert(view_state);
323 const VkImage &image = view_state->create_info.image;
324 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700325 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700326 // TODO: Do not iterate over every possibility - consolidate where possible
327 for (uint32_t j = 0; j < subRange.levelCount; j++) {
328 uint32_t level = subRange.baseMipLevel + j;
329 for (uint32_t k = 0; k < subRange.layerCount; k++) {
330 uint32_t layer = subRange.baseArrayLayer + k;
331 VkImageSubresource sub = {subRange.aspectMask, level, layer};
332 IMAGE_CMD_BUF_LAYOUT_NODE node;
333 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700334 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700335 continue;
336 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700337 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600338 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
339 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -0700340 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
341 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
342 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600343 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700344 }
345 }
346 }
347 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600348 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700349}
350
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700351void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700352 VkAttachmentReference ref) {
353 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
354 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
355 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
356 }
357}
358
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700359void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700360 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700361 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700362
363 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700364 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700365 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
366 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
367 }
368 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
369 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
370 }
371 if (subpass.pDepthStencilAttachment) {
372 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
373 }
374 }
375}
376
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600377bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700378 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700379 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
380 return false;
381 }
382 VkImageSubresource sub = {aspect, level, layer};
383 IMAGE_CMD_BUF_LAYOUT_NODE node;
384 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700385 return false;
386 }
387 bool skip = false;
388 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
389 // TODO: Set memory invalid which is in mem_tracker currently
390 } else if (node.layout != mem_barrier->oldLayout) {
Petr Kraus13c98a62017-12-09 00:22:39 +0100391 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
392 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer), __LINE__,
393 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
394 "For image 0x%" PRIx64 " you cannot transition the layout of aspect %d from %s when current layout is %s.",
395 HandleToUint64(mem_barrier->image), aspect, string_VkImageLayout(mem_barrier->oldLayout),
396 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700397 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700398 return skip;
399}
400
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700401// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
402// 1. Transition into initialLayout state
403// 2. Transition from initialLayout to layout used in subpass 0
404void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
405 FRAMEBUFFER_STATE *framebuffer_state) {
406 // First transition into initialLayout
407 auto const rpci = render_pass_state->createInfo.ptr();
408 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
409 VkImageView image_view = framebuffer_state->createInfo.pAttachments[i];
410 SetImageViewLayout(device_data, cb_state, image_view, rpci->pAttachments[i].initialLayout);
411 }
412 // Now transition for first subpass (index 0)
413 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
414}
415
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700416void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
417 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
418 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
419 return;
420 }
421 VkImageSubresource sub = {aspect, level, layer};
422 IMAGE_CMD_BUF_LAYOUT_NODE node;
423 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700424 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700425 SetLayout(device_data, pCB, mem_barrier->image, sub,
426 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
427 return;
428 }
429 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
430 // TODO: Set memory invalid
431 }
432 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
433}
434
Dave Houlton10b39482017-03-16 13:18:15 -0600435bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600436 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600437 if (!FormatIsColor(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600438 }
439 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600440 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600441 }
442 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600443 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600444 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700445 if (0 !=
446 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
447 if (FormatPlaneCount(format) == 1) return false;
448 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600449 return true;
450}
451
Mike Weiblen62d08a32017-03-07 22:18:27 -0700452// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
453bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
454 VkImageUsageFlags usage_flags, const char *func_name) {
455 const auto report_data = core_validation::GetReportData(device_data);
456 bool skip = false;
457 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
458 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
459
460 switch (layout) {
461 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
462 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600463 msg_code = VALIDATION_ERROR_0a000970;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700464 }
465 break;
466 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
467 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600468 msg_code = VALIDATION_ERROR_0a000972;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700469 }
470 break;
471 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
472 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600473 msg_code = VALIDATION_ERROR_0a000974;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700474 }
475 break;
476 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
477 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600478 msg_code = VALIDATION_ERROR_0a000976;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700479 }
480 break;
481 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
482 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600483 msg_code = VALIDATION_ERROR_0a000978;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700484 }
485 break;
486 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
487 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600488 msg_code = VALIDATION_ERROR_0a00097a;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700489 }
490 break;
491 default:
492 // Other VkImageLayout values do not have VUs defined in this context.
493 break;
494 }
495
496 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600497 skip |=
498 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200499 HandleToUint64(img_barrier->image), __LINE__, msg_code, "DS",
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600500 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ". %s",
Petr Kraus13c98a62017-12-09 00:22:39 +0100501 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
502 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags, validation_error_map[msg_code]);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700503 }
504 return skip;
505}
506
507// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600508bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700509 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700510 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700511
Mike Weiblen62d08a32017-03-07 22:18:27 -0700512 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
513 auto img_barrier = &pImageMemoryBarriers[i];
514 if (!img_barrier) continue;
515
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600516 auto image_state = GetImageState(device_data, img_barrier->image);
517 if (image_state) {
518 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
519 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
520 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
521
522 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
523 if (image_state->layout_locked) {
524 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600525 skip |= log_msg(
526 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600527 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, 0, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100528 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600529 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Kraus13c98a62017-12-09 00:22:39 +0100530 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600531 string_VkImageLayout(img_barrier->newLayout));
532 }
533 }
534
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600535 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600536 // For a Depth/Stencil image both aspects MUST be set
537 if (FormatIsDepthAndStencil(image_create_info->format)) {
538 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
539 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
540 if ((aspect_mask & ds_mask) != (ds_mask)) {
Petr Kraus13c98a62017-12-09 00:22:39 +0100541 skip |= log_msg(
542 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
543 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), __LINE__, VALIDATION_ERROR_0a00096e,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700544 "DS",
545 "%s: Image barrier 0x%p references image 0x%" PRIx64
546 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ". %s",
Petr Kraus13c98a62017-12-09 00:22:39 +0100547 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
548 string_VkFormat(image_create_info->format), aspect_mask, validation_error_map[VALIDATION_ERROR_0a00096e]);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600549 }
550 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600551 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
552 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700553
Mike Weiblen62d08a32017-03-07 22:18:27 -0700554 for (uint32_t j = 0; j < level_count; j++) {
555 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
556 for (uint32_t k = 0; k < layer_count; k++) {
557 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600558 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
559 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
560 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
561 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700562 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
563 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
564 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
565 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
566 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
567 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
568 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
569 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700570 }
571 }
572 }
573 return skip;
574}
575
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700576void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
577 const VkImageMemoryBarrier *pImgMemBarriers) {
578 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700579
580 for (uint32_t i = 0; i < memBarrierCount; ++i) {
581 auto mem_barrier = &pImgMemBarriers[i];
582 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700583
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600584 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
585 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
586 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
587
Dave Houltonb3f4b282018-02-22 16:25:16 -0700588 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
589 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
590 // for all (potential) layer sub_resources.
591 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
592 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
593 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
594 }
595
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600596 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700597 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600598 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700599 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
600 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
601 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
602 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
603 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700604 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
605 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
606 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
607 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
608 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700609 }
610 }
611 }
612}
613
Tobin Ehlisc8266452017-04-07 12:20:30 -0600614bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600615 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600616 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700617 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600618 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600619 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700620
621 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
622 uint32_t layer = i + subLayers.baseArrayLayer;
623 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
624 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600625 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
626 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600627 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600628 // TODO: Improve log message in the next pass
Petr Kraus13c98a62017-12-09 00:22:39 +0100629 skip |= log_msg(
630 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
631 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
632 "%s: Cannot use image 0x%" PRIx64 " with specific layout %s that doesn't match the actual current layout %s.",
633 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600634 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700635 }
636 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600637 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
638 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
639 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700640 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
641 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600642 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200643 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer), __LINE__,
644 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100645 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
646 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700647 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600648 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600649 if (image_state->shared_presentable) {
650 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
651 // TODO: Add unique error id when available.
652 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
653 __LINE__, msg_code, "DS",
654 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
655 string_VkImageLayout(optimal_layout));
656 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600657 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700658 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600659 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600660 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 +0200661 HandleToUint64(cb_node->commandBuffer), __LINE__, msg_code, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100662 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL. %s", caller,
663 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout),
664 validation_error_map[msg_code]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700665 }
666 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600667 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700668}
669
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700670void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
671 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700672 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700673 if (!renderPass) return;
674
675 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
676 if (framebuffer_state) {
677 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
678 auto image_view = framebuffer_state->createInfo.pAttachments[i];
679 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
680 }
681 }
682}
Dave Houltone19e20d2018-02-02 16:32:41 -0700683
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700684bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700685 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600686 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700687 const debug_report_data *report_data = core_validation::GetReportData(device_data);
688
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600689 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600690 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 -0600691 VALIDATION_ERROR_09e0075e, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
692 validation_error_map[VALIDATION_ERROR_09e0075e]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600693
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600694 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600695 }
696
Dave Houlton130c0212018-01-29 13:39:56 -0700697 bool optimal_tiling = (VK_IMAGE_TILING_OPTIMAL == pCreateInfo->tiling);
698 const char *tiling_string = string_VkImageTiling(pCreateInfo->tiling);
699 const char *format_string = string_VkFormat(pCreateInfo->format);
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600700 VkFormatProperties properties = GetFormatProperties(device_data, pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700701 VkFormatFeatureFlags features = (optimal_tiling ? properties.optimalTilingFeatures : properties.linearTilingFeatures);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600702
Dave Houlton130c0212018-01-29 13:39:56 -0700703 if (0 == features) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600704 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700705 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ac : VALIDATION_ERROR_09e007a2);
706 ss << "vkCreateImage format parameter " << format_string << " is an unsupported format";
707 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
708 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600709 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600710 }
711
Dave Houlton130c0212018-01-29 13:39:56 -0700712 if ((pCreateInfo->usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600713 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700714 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ae : VALIDATION_ERROR_09e007a4);
715 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_SAMPLED_BIT is not supported for format " << format_string << " with tiling "
716 << tiling_string;
717 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
718 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
719 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600720
Dave Houlton130c0212018-01-29 13:39:56 -0700721 if ((pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
722 std::stringstream ss;
723 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b0 : VALIDATION_ERROR_09e007a6);
724 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_STORAGE_BIT is not supported for format " << format_string << " with tiling "
725 << tiling_string;
726 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
727 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600728 }
729
Lenny Komowb79f04a2017-09-18 17:07:00 -0600730 // TODO: Add checks for EXTENDED_USAGE images to validate images are compatible
731 // For EXTENDED_USAGE images, format can match any image COMPATIBLE with original image
732 if (!GetDeviceExtensions(device_data)->vk_khr_maintenance2 || !(pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR)) {
733 // Validate that format supports usage as color attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700734 if ((pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
735 (0 == (features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT))) {
736 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b2 : VALIDATION_ERROR_09e007a8);
737 std::stringstream ss;
738 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_COLOR_ATTACHMENT is not supported for format " << format_string
739 << " with tiling " << tiling_string;
740 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
741 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600742 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600743
Lenny Komowb79f04a2017-09-18 17:07:00 -0600744 // Validate that format supports usage as depth/stencil attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700745 if ((pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
746 (0 == (features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
747 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b4 : VALIDATION_ERROR_09e007aa);
748 std::stringstream ss;
749 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT is not supported for format " << format_string
750 << " with tiling " << tiling_string;
751 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
752 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
753 }
754 }
755
756 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
757 std::stringstream ss;
758 ss << "vkCreateImage: Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set";
759 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
760 VALIDATION_ERROR_09e0076a, "IMAGE", "%s. %s", ss.str().c_str(),
761 validation_error_map[VALIDATION_ERROR_09e0076a]);
762 }
763
764 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
765 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
766 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
767 if (VK_SUCCESS != err) {
768 std::stringstream ss;
769 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
770 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
771 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
772 VALIDATION_ERROR_09e00758, "IMAGE", "%s. %s", ss.str().c_str(),
773 validation_error_map[VALIDATION_ERROR_09e00758]);
774 return skip;
775 }
776
777 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
778 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
779 std::stringstream ss;
780 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
781 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
782 VALIDATION_ERROR_09e0076e, "IMAGE", "%s. %s", ss.str().c_str(),
783 validation_error_map[VALIDATION_ERROR_09e0076e]);
784 }
785
786 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
787 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
788 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
789 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600790 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700791 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600792 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Dave Houlton130c0212018-01-29 13:39:56 -0700793 VALIDATION_ERROR_09e00770, "IMAGE", "%s. %s", ss.str().c_str(),
794 validation_error_map[VALIDATION_ERROR_09e00770]);
Lenny Komowb79f04a2017-09-18 17:07:00 -0600795 }
Dave Houlton130c0212018-01-29 13:39:56 -0700796 } else {
797 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
798 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, 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 cube-compatible images with "
801 "format "
802 << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600803 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Dave Houlton130c0212018-01-29 13:39:56 -0700804 VALIDATION_ERROR_09e00772, "IMAGE", "%s. %s", ss.str().c_str(),
805 validation_error_map[VALIDATION_ERROR_09e00772]);
Lenny Komowb79f04a2017-09-18 17:07:00 -0600806 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600807 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700808 }
809
Dave Houlton130c0212018-01-29 13:39:56 -0700810 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
811 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
812 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
813 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
814 std::stringstream ss;
815 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
816 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
817 VALIDATION_ERROR_09e00776, "IMAGE", "%s. %s", ss.str().c_str(),
818 validation_error_map[VALIDATION_ERROR_09e00776]);
819 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700820 }
821
Dave Houlton130c0212018-01-29 13:39:56 -0700822 // 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 -0700823 // 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 -0700824 // implementation shown. DJH
825 //
826 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
827 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
828 // device_limits->maxImageDimension3D)) {
829 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
830 std::stringstream ss;
831 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
832 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
833 VALIDATION_ERROR_09e0077e, "IMAGE", "%s. %s", ss.str().c_str(),
834 validation_error_map[VALIDATION_ERROR_09e0077e]);
835 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700836
Dave Houlton130c0212018-01-29 13:39:56 -0700837 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
838 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
839 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
840 std::stringstream ss;
841 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
842 "maxFramebufferWidth";
843 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
844 VALIDATION_ERROR_09e00788, "IMAGE", "%s. %s", ss.str().c_str(),
845 validation_error_map[VALIDATION_ERROR_09e00788]);
846 }
847
848 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
849 std::stringstream ss;
850 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
851 "maxFramebufferHeight";
852 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
853 VALIDATION_ERROR_09e0078a, "IMAGE", "%s. %s", ss.str().c_str(),
854 validation_error_map[VALIDATION_ERROR_09e0078a]);
855 }
856
857 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
858 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
859 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
860
861 // Round up to imageGranularity boundary
862 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
863 uint64_t ig_mask = imageGranularity - 1;
864 total_size = (total_size + ig_mask) & ~ig_mask;
865
866 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600867 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
868 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
Dave Houltona9df0ce2018-02-07 10:51:23 -0700869 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
870 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -0700871 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700872 }
873
Dave Houlton130c0212018-01-29 13:39:56 -0700874 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600875 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 -0700876 VALIDATION_ERROR_09e00780, "Image",
877 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s",
878 pCreateInfo->arrayLayers, format_limits.maxArrayLayers, validation_error_map[VALIDATION_ERROR_09e00780]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700879 }
880
Dave Houlton130c0212018-01-29 13:39:56 -0700881 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600882 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600883 VALIDATION_ERROR_09e0078e, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Dave Houlton130c0212018-01-29 13:39:56 -0700884 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600885 validation_error_map[VALIDATION_ERROR_09e0078e]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700886 }
887
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600888 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600889 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 -0600890 VALIDATION_ERROR_09e00792, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600891 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
892 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600893 validation_error_map[VALIDATION_ERROR_09e00792]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600894 }
895
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600896 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600897 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
898 DRAWSTATE_INVALID_FEATURE, "DS",
899 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
900 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600901 }
902
Lenny Komowb79f04a2017-09-18 17:07:00 -0600903 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
904 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
905 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
906 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
907 // TODO: Add Maintenance2 VUID
908 skip |=
909 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
910 VALIDATION_ERROR_UNDEFINED, "DS",
911 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
912 "format must be block, ETC or ASTC compressed, but is %s",
913 string_VkFormat(pCreateInfo->format));
914 }
915 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
916 // TODO: Add Maintenance2 VUID
917 skip |=
918 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
919 VALIDATION_ERROR_UNDEFINED, "DS",
920 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
921 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
922 }
923 }
924 }
925
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600926 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700927}
928
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700929void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700930 IMAGE_LAYOUT_NODE image_state;
931 image_state.layout = pCreateInfo->initialLayout;
932 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700933 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 -0700934 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700935 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
936 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700937}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700938
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700939bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700940 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700941 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200942 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700943 if (disabled->destroy_image) return false;
944 bool skip = false;
945 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600946 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
947 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700948 }
949 return skip;
950}
951
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700952void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700953 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
954 // Clean up memory mapping, bindings and range references for image
955 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700956 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700957 if (mem_info) {
958 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
959 }
960 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600961 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700962 // Remove image from imageMap
963 core_validation::GetImageMap(device_data)->erase(image);
964 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
965 core_validation::GetImageSubresourceMap(device_data);
966
967 const auto &sub_entry = imageSubresourceMap->find(image);
968 if (sub_entry != imageSubresourceMap->end()) {
969 for (const auto &pair : sub_entry->second) {
970 core_validation::GetImageLayoutMap(device_data)->erase(pair);
971 }
972 imageSubresourceMap->erase(sub_entry);
973 }
974}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700975
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700976bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700977 bool skip = false;
978 const debug_report_data *report_data = core_validation::GetReportData(device_data);
979
980 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
981 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
982 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 +0200983 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700984 }
985
Dave Houlton1d2022c2017-03-29 11:43:58 -0600986 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700987 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
988 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 -0600989 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
990 validation_error_map[VALIDATION_ERROR_1880000e]);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600991 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700992 char const str[] = "vkCmdClearColorImage called with compressed image.";
993 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 -0600994 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
995 validation_error_map[VALIDATION_ERROR_1880000e]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700996 }
997
998 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
999 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1000 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 -06001001 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_18800004, "IMAGE", "%s. %s", str,
1002 validation_error_map[VALIDATION_ERROR_18800004]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001003 }
1004 return skip;
1005}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001006
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001007uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1008 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1009 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001010 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001011 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001012 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001013 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001014}
1015
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001016uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1017 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1018 uint32_t array_layer_count = range->layerCount;
1019 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1020 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001021 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001022 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001023}
1024
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001025bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001026 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1027 bool skip = false;
1028 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1029
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001030 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1031 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001032
1033 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1034 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001035 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1036 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001037 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 +02001038 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001039 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1040 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001041 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001042 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001043 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001044 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 -06001045 HandleToUint64(image_state->image), __LINE__, 0, "DS",
1046 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1047 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001048
1049 } else {
1050 if (image_state->shared_presentable) {
1051 skip |= log_msg(
1052 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001053 HandleToUint64(image_state->image), __LINE__, 0, "DS",
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001054 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1055 string_VkImageLayout(dest_image_layout));
1056 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001057 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001058 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001059 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001060 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001061 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001062 } else {
1063 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1064 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001065 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 +02001066 HandleToUint64(image_state->image), __LINE__, error_code, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001067 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL. %s", func_name,
1068 string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001069 }
1070 }
1071
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001072 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1073 uint32_t level = level_index + range.baseMipLevel;
1074 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1075 uint32_t layer = layer_index + range.baseArrayLayer;
1076 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001077 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001078 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001079 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001080 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001081 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001082 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001083 } else {
1084 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1085 }
1086 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1087 __LINE__, error_code, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001088 "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s. %s",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001089 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
1090 validation_error_map[error_code]);
1091 }
1092 }
1093 }
1094 }
1095
1096 return skip;
1097}
1098
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001099void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1100 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001101 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1102 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1103 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001104
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001105 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1106 uint32_t level = level_index + range.baseMipLevel;
1107 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1108 uint32_t layer = layer_index + range.baseArrayLayer;
1109 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001110 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001111 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1112 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 -07001113 }
1114 }
1115 }
1116}
1117
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001118bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001119 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1120 bool skip = false;
1121 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001122 auto cb_node = GetCBNode(dev_data, commandBuffer);
1123 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001124 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001125 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001126 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001127 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001128 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001129 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001130 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001131 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001132 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001133 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001134 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001135 }
1136 }
1137 return skip;
1138}
1139
1140// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001141void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001142 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001143 auto cb_node = GetCBNode(dev_data, commandBuffer);
1144 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001145 if (cb_node && image_state) {
1146 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1147 std::function<bool()> function = [=]() {
1148 SetImageMemoryValid(dev_data, image_state, true);
1149 return false;
1150 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001151 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001152 for (uint32_t i = 0; i < rangeCount; ++i) {
1153 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1154 }
1155 }
1156}
1157
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001158bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1159 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001160 const VkImageSubresourceRange *pRanges) {
1161 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001162 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1163
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001164 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001165 auto cb_node = GetCBNode(device_data, commandBuffer);
1166 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001167 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001168 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001169 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001170 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001171 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001172 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001173 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001174 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001175 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001176 skip |=
1177 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001178 // Image aspect must be depth or stencil or both
1179 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1180 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1181 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001182 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1183 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001184 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 +02001185 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001186 }
1187 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001188 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001189 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001190 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1191 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a0001c, "IMAGE", "%s. %s", str,
1192 validation_error_map[VALIDATION_ERROR_18a0001c]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001193 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001194 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1195 char const str[] =
1196 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1197 "set.";
1198 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1199 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00012, "IMAGE", "%s. %s", str,
1200 validation_error_map[VALIDATION_ERROR_18a00012]);
1201 }
1202 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1203 VkImageTiling tiling = image_state->createInfo.tiling;
1204 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1205 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1206 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
1207 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1208 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00010, "IMAGE",
1209 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1210 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR. %s",
1211 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling),
1212 validation_error_map[VALIDATION_ERROR_18a00010]);
1213 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001214 }
1215 return skip;
1216}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001217
1218// Returns true if [x, xoffset] and [y, yoffset] overlap
1219static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1220 bool result = false;
1221 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1222 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1223
1224 if (intersection_max > intersection_min) {
1225 result = true;
1226 }
1227 return result;
1228}
1229
1230// Returns true if two VkImageCopy structures overlap
Dave Houltonf5217612018-02-02 16:18:52 -07001231static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001232 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001233
1234 if (is_multiplane && (src->srcSubresource.aspectMask != dst->dstSubresource.aspectMask)) {
1235 return result;
1236 }
1237
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001238 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1239 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1240 dst->dstSubresource.layerCount))) {
1241 result = true;
1242 switch (type) {
1243 case VK_IMAGE_TYPE_3D:
1244 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1245 // Intentionally fall through to 2D case
1246 case VK_IMAGE_TYPE_2D:
1247 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1248 // Intentionally fall through to 1D case
1249 case VK_IMAGE_TYPE_1D:
1250 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1251 break;
1252 default:
1253 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1254 assert(false);
1255 }
1256 }
1257 return result;
1258}
1259
Dave Houltonfc1a4052017-04-27 14:32:45 -06001260// Returns non-zero if offset and extent exceed image extents
1261static const uint32_t x_bit = 1;
1262static const uint32_t y_bit = 2;
1263static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001264static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001265 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001266 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001267 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1268 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001269 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001270 }
1271 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1272 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001273 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001274 }
1275 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1276 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001277 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001278 }
1279 return result;
1280}
1281
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001282// Test if two VkExtent3D structs are equivalent
1283static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1284 bool result = true;
1285 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1286 (extent->depth != other_extent->depth)) {
1287 result = false;
1288 }
1289 return result;
1290}
1291
Dave Houltonee281a52017-12-08 13:51:02 -07001292// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1293// Destination image texel extents must be adjusted by block size for the dest validation checks
1294VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1295 VkExtent3D adjusted_extent = extent;
1296 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1297 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1298 adjusted_extent.width /= block_size.width;
1299 adjusted_extent.height /= block_size.height;
1300 adjusted_extent.depth /= block_size.depth;
1301 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1302 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1303 adjusted_extent.width *= block_size.width;
1304 adjusted_extent.height *= block_size.height;
1305 adjusted_extent.depth *= block_size.depth;
1306 }
1307 return adjusted_extent;
1308}
1309
Dave Houlton6f9059e2017-05-02 17:15:13 -06001310// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001311static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1312 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001313
1314 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001315 if (mip >= img->createInfo.mipLevels) {
1316 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001317 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001318
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001319 // 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 -06001320 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001321 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1322 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1323 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001324
Dave Houlton6f9059e2017-05-02 17:15:13 -06001325 // Image arrays have an effective z extent that isn't diminished by mip level
1326 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001327 extent.depth = img->createInfo.arrayLayers;
1328 }
1329
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001330 return extent;
1331}
1332
1333// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001334static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001335 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1336}
1337
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001338// Test if the extent argument has any dimensions set to 0.
1339static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1340 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1341}
1342
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001343// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1344static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1345 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1346 VkExtent3D granularity = {0, 0, 0};
1347 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1348 if (pPool) {
1349 granularity =
1350 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001351 if (FormatIsCompressed(img->createInfo.format)) {
1352 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001353 granularity.width *= block_size.width;
1354 granularity.height *= block_size.height;
1355 }
1356 }
1357 return granularity;
1358}
1359
1360// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1361static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1362 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001363 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1364 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001365 valid = false;
1366 }
1367 return valid;
1368}
1369
1370// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1371static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1372 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1373 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1374 bool skip = false;
1375 VkExtent3D offset_extent = {};
1376 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1377 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1378 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001379 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001380 // 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 -07001381 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001382 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1383 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001384 "%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 "
1385 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001386 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001387 }
1388 } else {
1389 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1390 // integer multiples of the image transfer granularity.
1391 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001392 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1393 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07001394 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1395 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001396 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1397 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001398 }
1399 }
1400 return skip;
1401}
1402
1403// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1404static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1405 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001406 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001407 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1408 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001409 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001410 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1411 // subresource extent.
1412 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001413 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1414 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1415 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1416 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1417 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1418 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001419 }
1420 } else {
1421 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1422 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1423 // subresource extent dimensions.
1424 VkExtent3D offset_extent_sum = {};
1425 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1426 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1427 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001428 bool x_ok = true;
1429 bool y_ok = true;
1430 bool z_ok = true;
1431 switch (image_type) {
1432 case VK_IMAGE_TYPE_3D:
1433 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1434 (subresource_extent->depth == offset_extent_sum.depth));
1435 // Intentionally fall through to 2D case
1436 case VK_IMAGE_TYPE_2D:
1437 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1438 (subresource_extent->height == offset_extent_sum.height));
1439 // Intentionally fall through to 1D case
1440 case VK_IMAGE_TYPE_1D:
1441 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1442 (subresource_extent->width == offset_extent_sum.width));
1443 break;
1444 default:
1445 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1446 assert(false);
1447 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001448 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001449 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1450 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1451 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1452 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1453 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1454 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1455 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1456 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001457 }
1458 }
1459 return skip;
1460}
1461
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001462// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001463bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1464 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1465 const uint32_t i, const char *function) {
1466 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001467 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001468 // TODO: Add granularity checking for compressed formats
1469
1470 // bufferRowLength must be a multiple of the compressed texel block width
1471 // bufferImageHeight must be a multiple of the compressed texel block height
1472 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1473 // bufferOffset must be a multiple of the compressed texel block size in bytes
1474 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1475 // must equal the image subresource width
1476 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1477 // must equal the image subresource height
1478 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1479 // must equal the image subresource depth
1480 } else {
1481 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001482 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1483 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1484 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001485 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001486 }
1487 return skip;
1488}
1489
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001490// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001491bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001492 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1493 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001494 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001495 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001496 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001497 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001498 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001499 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001500 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001501 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001502
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001503 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001504 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001505 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houltonee281a52017-12-08 13:51:02 -07001506 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001507 const VkExtent3D dest_effective_extent =
1508 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001509 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001510 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001511 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001512 return skip;
1513}
1514
Dave Houlton6f9059e2017-05-02 17:15:13 -06001515// Validate contents of a VkImageCopy struct
1516bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1517 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1518 bool skip = false;
1519
1520 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001521 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001522
1523 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001524 const VkExtent3D src_copy_extent = region.extent;
1525 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001526 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1527
Dave Houlton6f9059e2017-05-02 17:15:13 -06001528 bool slice_override = false;
1529 uint32_t depth_slices = 0;
1530
1531 // Special case for copying between a 1D/2D array and a 3D image
1532 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1533 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001534 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001535 slice_override = (depth_slices != 1);
1536 } 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 -07001537 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001538 slice_override = (depth_slices != 1);
1539 }
1540
1541 // Do all checks on source image
1542 //
1543 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001544 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1545 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1546 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00124, "IMAGE",
1547 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
1548 "be 0 and 1, respectively. %s",
1549 i, region.srcOffset.y, src_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00124]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001550 }
1551 }
1552
1553 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (src_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001554 if ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth)) {
1555 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1556 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00128, "IMAGE",
1557 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D and 2D images "
1558 "these must be 0 and 1, respectively. %s",
1559 i, region.srcOffset.z, src_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00128]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001560 }
1561 }
1562
1563 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001564 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001565 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001566 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001567 skip |=
1568 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001569 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001570 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
1571 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001572 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001573 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001574 }
1575 }
1576 } else { // Pre maint 1
1577 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001578 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001579 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1580 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1581 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1582 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
1583 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001584 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001585 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001586 }
1587 }
1588 }
1589
Dave Houlton6f9059e2017-05-02 17:15:13 -06001590 // Checks that apply only to compressed images
1591 if (FormatIsCompressed(src_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001592 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001593
1594 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001595 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1596 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1597 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001598 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 +01001599 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001600 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
1601 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001602 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001603 validation_error_map[VALIDATION_ERROR_09c0013a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001604 }
1605
Dave Houlton94a00372017-12-14 15:08:47 -07001606 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001607 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1608 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001609 skip |=
1610 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001611 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013c, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001612 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1613 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001614 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001615 validation_error_map[VALIDATION_ERROR_09c0013c]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001616 }
1617
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001618 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001619 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1620 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001621 skip |=
1622 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001623 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013e, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001624 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1625 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001626 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001627 validation_error_map[VALIDATION_ERROR_09c0013e]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001628 }
1629
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001630 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001631 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1632 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001633 skip |=
1634 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001635 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00140, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001636 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1637 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001638 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001639 validation_error_map[VALIDATION_ERROR_09c00140]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001640 }
1641 } // Compressed
1642
1643 // Do all checks on dest image
1644 //
1645 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001646 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001647 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1648 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00130, "IMAGE",
1649 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
1650 "these must be 0 and 1, respectively. %s",
1651 i, region.dstOffset.y, dst_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00130]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001652 }
1653 }
1654
1655 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001656 if ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001657 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1658 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00134, "IMAGE",
1659 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and dst_copy_extent.depth is %d. For 1D and 2D "
1660 "images these must be 0 and 1, respectively. %s",
1661 i, region.dstOffset.z, dst_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00134]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001662 }
1663 }
1664
1665 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001666 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001667 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001668 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001669 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1670 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001671 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001672 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001673 }
1674 }
1675 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001676 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001677 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001678 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001679 skip |=
1680 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001681 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001682 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1683 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001684 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001685 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001686 }
1687 }
1688 } else { // Pre maint 1
1689 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001690 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001691 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1692 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1693 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1694 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
1695 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001696 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001697 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001698 }
1699 }
1700 }
1701
Dave Houlton6f9059e2017-05-02 17:15:13 -06001702 // Checks that apply only to compressed images
1703 if (FormatIsCompressed(dst_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001704 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001705
1706 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001707 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1708 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1709 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001710 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 +01001711 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00144, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001712 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
1713 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001714 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001715 validation_error_map[VALIDATION_ERROR_09c00144]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001716 }
1717
Dave Houlton94a00372017-12-14 15:08:47 -07001718 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001719 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1720 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001721 skip |=
1722 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1723 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00146, "IMAGE",
1724 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
1725 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d). %s.",
1726 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width,
1727 validation_error_map[VALIDATION_ERROR_09c00146]);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001728 }
1729
Dave Houltonee281a52017-12-08 13:51:02 -07001730 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1731 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1732 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001733 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1734 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00148, "IMAGE",
1735 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1736 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
1737 "height (%d). %s.",
1738 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height,
1739 validation_error_map[VALIDATION_ERROR_09c00148]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001740 }
1741
Dave Houltonee281a52017-12-08 13:51:02 -07001742 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1743 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1744 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001745 skip |=
1746 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1747 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0014a, "IMAGE",
1748 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
1749 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d). %s.",
1750 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth,
1751 validation_error_map[VALIDATION_ERROR_09c0014a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001752 }
1753 } // Compressed
1754 }
1755 return skip;
1756}
1757
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001758bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001759 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1760 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001761 bool skip = false;
1762 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001763 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1764
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001765 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1766
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001767 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001768 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001769
1770 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1771 VkExtent3D src_copy_extent = region.extent;
1772 VkExtent3D dst_copy_extent =
1773 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1774
Dave Houlton6f9059e2017-05-02 17:15:13 -06001775 bool slice_override = false;
1776 uint32_t depth_slices = 0;
1777
1778 // Special case for copying between a 1D/2D array and a 3D image
1779 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1780 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1781 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001782 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001783 slice_override = (depth_slices != 1);
1784 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1785 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001786 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001787 slice_override = (depth_slices != 1);
1788 }
1789
Dave Houltonee281a52017-12-08 13:51:02 -07001790 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001791 std::stringstream ss;
1792 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001793 skip |=
1794 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1795 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001796 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001797
Dave Houltonee281a52017-12-08 13:51:02 -07001798 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001799 std::stringstream ss;
1800 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001801 skip |=
1802 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1803 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001804 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001805
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001806 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001807 // No chance of mismatch if we're overriding depth slice count
1808 if (!slice_override) {
1809 // The number of depth slices in srcSubresource and dstSubresource must match
1810 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1811 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001812 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1813 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001814 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001815 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1816 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001817 if (src_slices != dst_slices) {
1818 std::stringstream ss;
1819 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1820 << "] do not match";
1821 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001822 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1823 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001824 }
1825 }
1826 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001827 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001828 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001829 std::stringstream ss;
1830 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1831 << "] do not match";
1832 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 -06001833 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1834 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001835 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001836 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001837
Dave Houltonf5217612018-02-02 16:18:52 -07001838 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1839 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
1840 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1841 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1842 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1843 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00112, "IMAGE", "%s. %s", str,
1844 validation_error_map[VALIDATION_ERROR_09c00112]);
1845 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001846 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001847
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001848 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001849 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001850 std::stringstream ss;
1851 ss << "vkCmdCopyImage: pRegion[" << i
1852 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1853 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001854 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011c, "IMAGE", "%s. %s",
1855 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011c]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001856 }
1857
1858 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001859 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001860 std::stringstream ss;
1861 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1862 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 -06001863 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011e, "IMAGE", "%s. %s",
1864 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011e]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001865 }
1866
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001867 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001868 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1869 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001870 std::stringstream ss;
1871 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1872 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 -06001873 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600150, "IMAGE", "%s. %s",
1874 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600150]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001875 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001876
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001877 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1878 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001879 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1880 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001881 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1882 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 -06001883 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a60014e, "IMAGE", "%s. %s", str,
1884 validation_error_map[VALIDATION_ERROR_0a60014e]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001885 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001886
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001887 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001888 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001889 std::stringstream ss;
1890 ss << "vkCmdCopyImage: pRegions[" << i
1891 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1892 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 -06001893 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1894 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001895 }
Dave Houltonee281a52017-12-08 13:51:02 -07001896 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001897 std::stringstream ss;
1898 ss << "vkCmdCopyImage: pRegions[" << i
1899 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1900 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 -06001901 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1902 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001903 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001904
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001905 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1906 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001907 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001908 std::stringstream ss;
1909 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001910 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001911 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 -06001912 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1913 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001914 }
Dave Houltonee281a52017-12-08 13:51:02 -07001915 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001916 std::stringstream ss;
1917 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001918 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001919 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001920 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1921 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001922 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001923
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001924 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1925 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1926 // 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 -07001927 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1928 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001929 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001930 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1931 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1932 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1933 << " ] exceeds the source image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001934 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 -06001935 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f4, "IMAGE", "%s. %s",
1936 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f4]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001937 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001938
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001939 // 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 -07001940 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1941 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001942 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001943 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
1944 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
1945 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
1946 << " ] exceeds the destination image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001947 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 -06001948 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f6, "IMAGE", "%s. %s",
1949 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f6]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001950 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001951 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001952
Dave Houltonfc1a4052017-04-27 14:32:45 -06001953 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07001954 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1955 if (slice_override) src_copy_extent.depth = depth_slices;
1956 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 if (extent_check & x_bit) {
1958 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 -06001959 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00120, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001960 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1961 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001962 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001963 validation_error_map[VALIDATION_ERROR_09c00120]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964 }
1965
1966 if (extent_check & y_bit) {
1967 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 -06001968 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00122, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001969 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1970 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001971 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001972 validation_error_map[VALIDATION_ERROR_09c00122]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001973 }
1974 if (extent_check & z_bit) {
1975 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 -06001976 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00126, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001977 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1978 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001979 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001980 validation_error_map[VALIDATION_ERROR_09c00126]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001981 }
1982
Dave Houltonee281a52017-12-08 13:51:02 -07001983 // Adjust dest extent if necessary
1984 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1985 if (slice_override) dst_copy_extent.depth = depth_slices;
1986
1987 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001988 if (extent_check & x_bit) {
1989 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 -06001990 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012c, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001991 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1992 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001993 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001994 validation_error_map[VALIDATION_ERROR_09c0012c]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001995 }
1996 if (extent_check & y_bit) {
1997 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001998 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012e, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001999 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2000 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07002001 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002002 validation_error_map[VALIDATION_ERROR_09c0012e]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002003 }
2004 if (extent_check & z_bit) {
2005 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 -06002006 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00132, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002007 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2008 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07002009 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002010 validation_error_map[VALIDATION_ERROR_09c00132]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002011 }
2012
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002013 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2014 // must not overlap in memory
2015 if (src_image_state->image == dst_image_state->image) {
2016 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002017 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2018 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002019 std::stringstream ss;
2020 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2021 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 -06002022 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f8, "IMAGE", "%s. %s",
2023 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f8]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002024 }
2025 }
2026 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002027 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002028
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002029 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2030 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2031 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002032 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002033 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2034 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002035 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2036 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002037 }
2038 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002039 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2040 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002041 if (srcSize != destSize) {
2042 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2043 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 -06002044 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_1900010e, "IMAGE", "%s. %s", str,
2045 validation_error_map[VALIDATION_ERROR_1900010e]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002046 }
2047 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002048
Dave Houlton33c22b72017-02-28 13:16:02 -07002049 // Source and dest image sample counts must match
2050 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2051 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2052 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 -06002053 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000110, "IMAGE", "%s %s", str,
2054 validation_error_map[VALIDATION_ERROR_19000110]);
Dave Houlton33c22b72017-02-28 13:16:02 -07002055 }
2056
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002057 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2058 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002059 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002060 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002061 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002062 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002063 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002064 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002065 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002066 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002067 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002068 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002069 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002070 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002071 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002072 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002073 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002074 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2075 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002076 }
2077
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002078 return skip;
2079}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002080
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002081void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002082 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2083 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2084 // Make sure that all image slices are updated to correct layout
2085 for (uint32_t i = 0; i < region_count; ++i) {
2086 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2087 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2088 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002089 // Update bindings between images and cmd buffer
2090 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2091 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002092 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002093 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002094 function = [=]() {
2095 SetImageMemoryValid(device_data, dst_image_state, true);
2096 return false;
2097 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002098 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002099}
2100
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002101// Returns true if sub_rect is entirely contained within rect
2102static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2103 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2104 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2105 return false;
2106 return true;
2107}
2108
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002109bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2110 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002111 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002112 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2113
2114 bool skip = false;
2115 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002116 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2117 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002118 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002119 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002120 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002121 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2122 // 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 -07002123 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2124 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002125 skip |= log_msg(
2126 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2127 HandleToUint64(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
2128 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2129 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2130 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002131 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002132 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002133 }
2134
2135 // Validate that attachment is in reference list of active subpass
2136 if (cb_node->activeRenderPass) {
2137 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2138 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002139 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002140
2141 for (uint32_t i = 0; i < attachmentCount; i++) {
2142 auto clear_desc = &pAttachments[i];
2143 VkImageView image_view = VK_NULL_HANDLE;
2144
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002145 if (0 == clear_desc->aspectMask) {
2146 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 -06002147 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c03, "IMAGE", "%s",
2148 validation_error_map[VALIDATION_ERROR_01c00c03]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002149 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2150 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002151 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00028, "IMAGE", "%s",
2152 validation_error_map[VALIDATION_ERROR_01c00028]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002153 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002154 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002155 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2156 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_1860001e, "DS",
2157 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
2158 clear_desc->colorAttachment, cb_node->activeSubpass,
2159 validation_error_map[VALIDATION_ERROR_1860001e]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002160 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2161 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002162 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer), __LINE__,
2163 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002164 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2165 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002166 } else {
2167 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002168 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002169 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002170 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2171 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2172 char const str[] =
2173 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
2174 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 -06002175 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00026, "IMAGE", str, i,
2176 validation_error_map[VALIDATION_ERROR_01c00026]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002177 }
2178 } else { // Must be depth and/or stencil
2179 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2180 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2181 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
2182 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 -06002183 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c01, "IMAGE", str, i,
2184 validation_error_map[VALIDATION_ERROR_01c00c01]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002185 }
2186 if (!subpass_desc->pDepthStencilAttachment ||
2187 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2188 skip |= log_msg(
2189 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002190 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002191 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002192 } else {
2193 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2194 }
2195 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002196 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002197 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002198 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002199 // The rectangular region specified by a given element of pRects must be contained within the render area of
2200 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07002201 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
2202 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
2203 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002204 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 -06002205 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002206 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2207 "the current render pass instance. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002208 j, validation_error_map[VALIDATION_ERROR_18600020]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002209 }
2210 // The layers specified by a given element of pRects must be contained within every attachment that
2211 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002212 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002213 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2214 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002215 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2216 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600022, "DS",
2217 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2218 "of pAttachment[%d]. %s",
2219 j, i, validation_error_map[VALIDATION_ERROR_18600022]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002220 }
2221 }
2222 }
2223 }
2224 }
2225 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002226}
2227
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002228bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002229 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002230 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002231 bool skip = false;
2232 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002233 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2234 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2235 skip |=
2236 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002237 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002238 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002239
2240 // For each region, the number of layers in the image subresource should not be zero
2241 // For each region, src and dest image aspect must be color only
2242 for (uint32_t i = 0; i < regionCount; i++) {
2243 if (pRegions[i].srcSubresource.layerCount == 0) {
2244 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002245 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 +02002246 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002247 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002248 if (pRegions[i].dstSubresource.layerCount == 0) {
2249 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002250 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 +02002251 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002252 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002253 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2254 skip |= log_msg(
2255 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002256 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200216, "IMAGE",
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002257 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002258 validation_error_map[VALIDATION_ERROR_0a200216]);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002259 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002260 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2261 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2262 char const str[] =
2263 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2264 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 -06002265 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200214, "IMAGE", "%s. %s", str,
2266 validation_error_map[VALIDATION_ERROR_0a200214]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002267 }
2268 }
2269
2270 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2271 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002272 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 +02002273 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002274 }
2275 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2276 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002277 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 +02002278 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002279 }
2280 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2281 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2282 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 -06002283 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800202, "IMAGE", "%s. %s", str,
2284 validation_error_map[VALIDATION_ERROR_1c800202]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002285 }
2286 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2287 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2288 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002289 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800206, "IMAGE", "%s. %s", str,
2290 validation_error_map[VALIDATION_ERROR_1c800206]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002291 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002292 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002293 } else {
2294 assert(0);
2295 }
2296 return skip;
2297}
2298
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002299void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2300 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002301 // Update bindings between images and cmd buffer
2302 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2303 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2304
2305 std::function<bool()> function = [=]() {
2306 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2307 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002308 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002309 function = [=]() {
2310 SetImageMemoryValid(device_data, dst_image_state, true);
2311 return false;
2312 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002313 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002314}
2315
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002316bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002317 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2318 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002319 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2320
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002321 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002322 if (cb_node) {
2323 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2324 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002325 if (cb_node && src_image_state && dst_image_state) {
2326 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002327 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002328 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002329 VALIDATION_ERROR_184001d4);
2330 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2331 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2332 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2333 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2334 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2335 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2336 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002337 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002338 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002339 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002340
Dave Houlton33c2d252017-06-09 17:08:32 -06002341 VkFormat src_format = src_image_state->createInfo.format;
2342 VkFormat dst_format = dst_image_state->createInfo.format;
2343 VkImageType src_type = src_image_state->createInfo.imageType;
2344 VkImageType dst_type = dst_image_state->createInfo.imageType;
2345
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002346 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002347 VkImageTiling tiling = src_image_state->createInfo.tiling;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002348 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002349 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2350 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2351 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b4, "IMAGE",
2352 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature. %s",
2353 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001b4]);
2354 }
2355
2356 if ((VK_FILTER_LINEAR == filter) &&
2357 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
2358 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2359 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d6, "IMAGE",
2360 "vkCmdBlitImage: source image format %s does not support linear filtering. %s",
2361 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d6]);
2362 }
2363
2364 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2365 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
2366 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2367 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d8, "IMAGE",
2368 "vkCmdBlitImage: source image format %s does not support cubic filtering. %s",
2369 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d8]);
2370 }
2371
2372 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2373 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2374 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001da, "IMAGE",
2375 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified. %s",
2376 validation_error_map[VALIDATION_ERROR_184001da]);
2377 }
2378
2379 props = GetFormatProperties(device_data, dst_format);
2380 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002381 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002382 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
2383 skip |=
2384 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2385 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001be, "IMAGE",
2386 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature. %s",
2387 string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_184001be]);
2388 }
2389
2390 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2391 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2392 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2393 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001c8, "IMAGE",
2394 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT. %s",
2395 validation_error_map[VALIDATION_ERROR_184001c8]);
2396 }
2397
2398 // Validate consistency for unsigned formats
2399 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2400 std::stringstream ss;
2401 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2402 << "the other one must also have unsigned integer format. "
2403 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2404 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2405 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001cc, "IMAGE", "%s. %s",
2406 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001cc]);
2407 }
2408
2409 // Validate consistency for signed formats
2410 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2411 std::stringstream ss;
2412 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2413 << "the other one must also have signed integer format. "
2414 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2415 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2416 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ca, "IMAGE", "%s. %s",
2417 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ca]);
2418 }
2419
2420 // Validate filter for Depth/Stencil formats
2421 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2422 std::stringstream ss;
2423 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2424 << "then filter must be VK_FILTER_NEAREST.";
2425 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2426 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d0, "IMAGE", "%s. %s",
2427 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001d0]);
2428 }
2429
2430 // Validate aspect bits and formats for depth/stencil images
2431 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2432 if (src_format != dst_format) {
2433 std::stringstream ss;
2434 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2435 << "stencil, the other one must have exactly the same format. "
2436 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2437 << string_VkFormat(dst_format);
2438 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2439 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ce, "IMAGE", "%s. %s",
2440 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ce]);
2441 }
2442
2443#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2444 for (uint32_t i = 0; i < regionCount; i++) {
2445 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2446
2447 if (FormatIsDepthAndStencil(src_format)) {
2448 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2449 std::stringstream ss;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002450 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of VK_IMAGE_ASPECT_DEPTH_BIT "
Dave Houlton33c2d252017-06-09 17:08:32 -06002451 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2452 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2453 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2454 "%s", ss.str().c_str());
2455 }
2456 }
2457 else if (FormatIsStencilOnly(src_format)) {
2458 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2459 std::stringstream ss;
2460 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2461 << "set in both the srcImage and dstImage";
2462 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2463 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2464 "%s", ss.str().c_str());
2465 }
2466 }
2467 else if (FormatIsDepthOnly(src_format)) {
2468 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2469 std::stringstream ss;
2470 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2471 << "set in both the srcImage and dstImage";
2472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2473 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2474 "%s", ss.str().c_str());
2475 }
2476 }
2477 }
2478#endif
2479 } // Depth or Stencil
2480
2481 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002482 for (uint32_t i = 0; i < region_count; i++) {
2483 const VkImageBlit rgn = regions[i];
2484 bool hit_error = false;
2485 skip |=
2486 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2487 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2488 skip |=
2489 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2490 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002491
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002492 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002493 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2494 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002495 std::stringstream ss;
2496 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2497 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 +02002498 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2499 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002500 }
Dave Houlton48989f32017-05-26 15:01:46 -06002501 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2502 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002503 std::stringstream ss;
2504 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2505 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 +02002506 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2507 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002508 }
Dave Houlton48989f32017-05-26 15:01:46 -06002509 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002510 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2511 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 +02002512 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002513 }
Dave Houlton48989f32017-05-26 15:01:46 -06002514 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002515 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2516 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 +02002517 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002518 }
2519
2520 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002521 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002522 skip |=
2523 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 -06002524 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001de, "IMAGE",
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002525 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002526 i, validation_error_map[VALIDATION_ERROR_09a001de]);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002527 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002528
Dave Houlton48989f32017-05-26 15:01:46 -06002529 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002530 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 -06002531 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001dc, "IMAGE",
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002532 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002533 validation_error_map[VALIDATION_ERROR_09a001dc]);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002534 }
Dave Houlton48989f32017-05-26 15:01:46 -06002535
Dave Houlton33c2d252017-06-09 17:08:32 -06002536 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2537 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2538 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e2, "IMAGE",
2539 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
2540 "image format %s. %s",
2541 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format),
2542 validation_error_map[VALIDATION_ERROR_09a001e2]);
2543 }
2544
2545 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2546 skip |= log_msg(
2547 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2548 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e4, "IMAGE",
2549 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s. %s",
2550 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_09a001e4]);
2551 }
2552
Dave Houlton48989f32017-05-26 15:01:46 -06002553 // Validate source image offsets
2554 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002555 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002556 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2557 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2558 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ea, "IMAGE",
2559 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
2560 "of (%1d, %1d). These must be (0, 1). %s",
2561 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001ea]);
2562 }
2563 }
2564
Dave Houlton33c2d252017-06-09 17:08:32 -06002565 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002566 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2567 skip |= 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_09a001ee, "IMAGE",
2569 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2570 "srcOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2571 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001ee]);
2572 }
2573 }
2574
Dave Houlton33c2d252017-06-09 17:08:32 -06002575 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002576 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2577 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002578 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002579 skip |= log_msg(
2580 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2581 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e6, "IMAGE",
2582 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d). %s", i,
2583 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width, validation_error_map[VALIDATION_ERROR_09a001e6]);
2584 }
2585 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2586 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002587 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002588 skip |= log_msg(
2589 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2590 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e8, "IMAGE",
2591 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d). %s", i,
2592 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height, validation_error_map[VALIDATION_ERROR_09a001e8]);
2593 }
2594 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2595 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002596 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002597 skip |= log_msg(
2598 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2599 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ec, "IMAGE",
2600 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d). %s", i,
2601 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth, validation_error_map[VALIDATION_ERROR_09a001ec]);
2602 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002603 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2604 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2605 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2606 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d. %s", i,
2607 rgn.srcSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001ae]);
2608 } else if (oob) {
2609 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2610 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2611 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions. %s", i,
2612 validation_error_map[VALIDATION_ERROR_184001ae]);
2613 }
Dave Houlton48989f32017-05-26 15:01:46 -06002614
2615 // Validate dest image offsets
2616 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002617 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002618 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2619 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2620 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f4, "IMAGE",
2621 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
2622 "(%1d, %1d). These must be (0, 1). %s",
2623 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001f4]);
2624 }
2625 }
2626
Dave Houlton33c2d252017-06-09 17:08:32 -06002627 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002628 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2629 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2630 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f8, "IMAGE",
2631 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2632 "dstOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2633 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001f8]);
2634 }
2635 }
2636
Dave Houlton33c2d252017-06-09 17:08:32 -06002637 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002638 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2639 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002640 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002641 skip |= log_msg(
2642 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2643 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f0, "IMAGE",
2644 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d). %s", i,
2645 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width, validation_error_map[VALIDATION_ERROR_09a001f0]);
2646 }
2647 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2648 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002649 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002650 skip |= log_msg(
2651 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2652 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f2, "IMAGE",
2653 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d). %s", i,
2654 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height, validation_error_map[VALIDATION_ERROR_09a001f2]);
2655 }
2656 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2657 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002658 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002659 skip |= log_msg(
2660 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2661 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f6, "IMAGE",
2662 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d). %s", i,
2663 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth, validation_error_map[VALIDATION_ERROR_09a001f6]);
2664 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002665 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002666 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 -06002667 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2668 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d. %s",
2669 i, rgn.dstSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001b0]);
2670 } else if (oob) {
2671 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2672 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2673 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions. %s", i,
2674 validation_error_map[VALIDATION_ERROR_184001b0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002675 }
2676
Dave Houlton33c2d252017-06-09 17:08:32 -06002677 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2678 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2679 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2680 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2681 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e0, "IMAGE",
2682 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
2683 "layerCount other than 1. %s",
2684 i, validation_error_map[VALIDATION_ERROR_09a001e0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002685 }
2686 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002687 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002688 } else {
2689 assert(0);
2690 }
2691 return skip;
2692}
2693
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002694void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002695 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2696 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2697 // Make sure that all image slices are updated to correct layout
2698 for (uint32_t i = 0; i < region_count; ++i) {
2699 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2700 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2701 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002702 // Update bindings between images and cmd buffer
2703 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2704 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2705
2706 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002707 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002708 function = [=]() {
2709 SetImageMemoryValid(device_data, dst_image_state, true);
2710 return false;
2711 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002712 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002713}
2714
Tony Barbourdf013b92017-01-25 12:53:48 -07002715// This validates that the initial layout specified in the command buffer for
2716// the IMAGE is the same
2717// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002718bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002719 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2720 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002721 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002722 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002723 for (auto cb_image_data : pCB->imageLayoutMap) {
2724 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002725
Dave Houltonb3f4b282018-02-22 16:25:16 -07002726 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2727 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002728 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2729 // TODO: Set memory invalid which is in mem_tracker currently
2730 } else if (imageLayout != cb_image_data.second.initialLayout) {
2731 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002732 skip |= log_msg(
2733 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2734 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2735 "Cannot submit cmd buffer using image (0x%" PRIx64
2736 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2737 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2738 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2739 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002740 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002741 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2742 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002743 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002744 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2745 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002746 }
2747 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002748 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002749 }
2750 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002751 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002752}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002753
Tony Barbourdf013b92017-01-25 12:53:48 -07002754void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2755 for (auto cb_image_data : pCB->imageLayoutMap) {
2756 VkImageLayout imageLayout;
2757 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2758 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2759 }
2760}
2761
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002762// Print readable FlagBits in FlagMask
2763static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2764 std::string result;
2765 std::string separator;
2766
2767 if (accessMask == 0) {
2768 result = "[None]";
2769 } else {
2770 result = "[";
2771 for (auto i = 0; i < 32; i++) {
2772 if (accessMask & (1 << i)) {
2773 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2774 separator = " | ";
2775 }
2776 }
2777 result = result + "]";
2778 }
2779 return result;
2780}
2781
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002782// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2783// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002784// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002785static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2786 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2787 const char *type) {
2788 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2789 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002790
2791 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2792 if (accessMask & ~(required_bit | optional_bits)) {
2793 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002794 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 +02002795 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002796 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2797 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002798 }
2799 } else {
2800 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002801 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 +02002802 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002803 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
2804 "has previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002805 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2806 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002807 } else {
2808 std::string opt_bits;
2809 if (optional_bits != 0) {
2810 std::stringstream ss;
2811 ss << optional_bits;
2812 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2813 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002814 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 +02002815 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002816 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
2817 "previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002818 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2819 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002820 }
2821 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002822 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002823}
2824
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002825// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002826// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2827// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002828bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002829 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2830 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002831 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2832 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2833 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2834 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskieb9e73f2017-04-13 10:06:48 -06002835 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 -06002836 VALIDATION_ERROR_12200688, "DS", "Cannot clear attachment %d with invalid first layout %s. %s",
2837 attachment, string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_12200688]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002838 }
2839 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002840 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002841}
2842
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002843bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2844 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002845 bool skip = false;
2846
Jason Ekstranda1906302017-12-03 20:16:32 -08002847 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2848 VkFormat format = pCreateInfo->pAttachments[i].format;
2849 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2850 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2851 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Tobin Ehlis73836462018-02-13 09:35:47 -07002852 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2853 DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002854 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
2855 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2856 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2857 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002858 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07002859 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Tobin Ehlis73836462018-02-13 09:35:47 -07002860 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2861 DRAWSTATE_INVALID_RENDERPASS, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002862 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
2863 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2864 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2865 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002866 }
2867 }
2868 }
2869
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002870 // Track when we're observing the first use of an attachment
2871 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2872 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2873 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002874
2875 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2876 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2877 auto attach_index = subpass.pInputAttachments[j].attachment;
2878 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2879
2880 switch (subpass.pInputAttachments[j].layout) {
2881 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2882 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2883 // These are ideal.
2884 break;
2885
2886 case VK_IMAGE_LAYOUT_GENERAL:
2887 // May not be optimal. TODO: reconsider this warning based on other constraints.
2888 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2889 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2890 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2891 break;
2892
2893 default:
2894 // No other layouts are acceptable
2895 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2896 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2897 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2898 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2899 }
2900
2901 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2902 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2903 subpass.pDepthStencilAttachment->attachment == attach_index &&
2904 subpass.pDepthStencilAttachment->layout != layout;
2905 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2906 found_layout_mismatch =
2907 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2908 }
2909 if (found_layout_mismatch) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002910 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2911 VALIDATION_ERROR_140006ae, "DS",
2912 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a "
2913 "depth/color attachment with a different layout. %s",
2914 i, j, attach_index, layout, validation_error_map[VALIDATION_ERROR_140006ae]);
Cort Stratton7547f772017-05-04 15:18:52 -07002915 }
2916
2917 if (attach_first_use[attach_index]) {
2918 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2919 pCreateInfo->pAttachments[attach_index]);
2920
2921 bool used_as_depth =
2922 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2923 bool used_as_color = false;
2924 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2925 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2926 }
2927 if (!used_as_depth && !used_as_color &&
2928 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2929 skip |= log_msg(
2930 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002931 VALIDATION_ERROR_1400069c, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002932 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002933 attach_index, attach_index, validation_error_map[VALIDATION_ERROR_1400069c]);
Cort Stratton7547f772017-05-04 15:18:52 -07002934 }
2935 }
2936 attach_first_use[attach_index] = false;
2937 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002938 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2939 auto attach_index = subpass.pColorAttachments[j].attachment;
2940 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2941
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002942 // TODO: Need a way to validate shared presentable images here, currently just allowing
2943 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2944 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002945 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002946 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002947 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002948 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2949 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002950 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002951
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002952 case VK_IMAGE_LAYOUT_GENERAL:
2953 // May not be optimal; TODO: reconsider this warning based on other constraints?
2954 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2955 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2956 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2957 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002958
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002959 default:
2960 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2961 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2962 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2963 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002964 }
2965
2966 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002967 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2968 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002969 }
2970 attach_first_use[attach_index] = false;
2971 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06002972
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002973 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2974 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002975 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2976 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2977 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06002978 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06002979
Dave Houltona9df0ce2018-02-07 10:51:23 -07002980 case VK_IMAGE_LAYOUT_GENERAL:
2981 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2982 // doing a bunch of transitions.
2983 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2984 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2985 "GENERAL layout for depth attachment may not give optimal performance.");
2986 break;
2987
2988 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
2989 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
2990 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
2991 break;
2992 } else {
2993 // Intentionally fall through to generic error message
2994 }
2995
2996 default:
2997 // No other layouts are acceptable
2998 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2999 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
3000 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3001 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3002 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003003 }
3004
3005 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3006 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003007 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
3008 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003009 }
3010 attach_first_use[attach_index] = false;
3011 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003012 }
3013 return skip;
3014}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003015
3016// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003017bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3018 VkDeviceSize offset, VkDeviceSize end_offset) {
3019 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3020 bool skip = false;
3021 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3022 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003023 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3024 for (auto image_handle : mem_info->bound_images) {
3025 auto img_it = mem_info->bound_ranges.find(image_handle);
3026 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003027 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003028 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003029 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003030 for (auto layout : layouts) {
3031 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003032 skip |=
3033 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
3034 HandleToUint64(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003035 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3036 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003037 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003038 }
3039 }
3040 }
3041 }
3042 }
3043 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003044 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003045}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003046
3047// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3048// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003049static 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 -06003050 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003051 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003052
3053 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003054 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003055 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003056 if (strict) {
3057 correct_usage = ((actual & desired) == desired);
3058 } else {
3059 correct_usage = ((actual & desired) != 0);
3060 }
3061 if (!correct_usage) {
3062 if (msgCode == -1) {
3063 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003064 skip =
3065 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__,
3066 MEMTRACK_INVALID_USAGE_FLAG, "MEM",
3067 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3068 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003069 } else {
3070 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Dave Houltona9df0ce2018-02-07 10:51:23 -07003071 skip = log_msg(
3072 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__, msgCode, "MEM",
3073 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation. %s",
3074 type_str, obj_handle, func_name, type_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003075 }
3076 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003077 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003078}
3079
3080// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3081// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003082bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003083 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003084 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3085 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003086}
3087
3088// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3089// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003090bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003091 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003092 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3093 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003094}
3095
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003096bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003097 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003098 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3099
Chris Forbese0f511c2017-06-14 12:38:01 -07003100 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003101
3102 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
3103 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 -06003104 VALIDATION_ERROR_01400726, "DS",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003105 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
3106 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003107 validation_error_map[VALIDATION_ERROR_01400726]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003108 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003109
3110 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003111 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3112 VALIDATION_ERROR_01400728, "DS",
3113 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
3114 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set. %s",
3115 validation_error_map[VALIDATION_ERROR_01400728]);
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003116 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003117
3118 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003119 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3120 VALIDATION_ERROR_0140072a, "DS",
3121 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
3122 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set. %s",
3123 validation_error_map[VALIDATION_ERROR_0140072a]);
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003124 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003125 return skip;
3126}
3127
3128void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3129 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3130 GetBufferMap(device_data)
3131 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3132}
3133
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003134bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3135 bool skip = false;
3136 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003137 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3138 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003139 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003140 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3141 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003142 skip |= ValidateBufferUsageFlags(
3143 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 -06003144 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003145 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003146 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003147}
3148
3149void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3150 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3151}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003152
3153// For the given format verify that the aspect masks make sense
3154bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3155 const char *func_name) {
3156 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3157 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003158 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003159 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003160 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 -06003161 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003162 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003163 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003164 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003165 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003166 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003167 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003168 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003169 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003170 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003171 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003172 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 -06003173 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003174 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
3175 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003176 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003177 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003178 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 -06003179 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003180 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
3181 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003182 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003183 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003184 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003185 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003186 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 -06003187 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003188 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003189 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003190 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003191 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 -06003192 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003193 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003194 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003195 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003196 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003197 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003198 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 -06003199 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003200 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003201 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003202 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003203 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003204 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003205 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003206 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003207 }
3208 }
3209 return skip;
3210}
3211
Petr Krausffa94af2017-08-08 21:46:02 +02003212struct SubresourceRangeErrorCodes {
3213 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3214};
3215
3216bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3217 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3218 const char *image_layer_count_var_name, const uint64_t image_handle,
3219 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003220 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3221 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003222
3223 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003224 if (subresourceRange.baseMipLevel >= image_mip_count) {
3225 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3226 errorCodes.base_mip_err, "IMAGE",
3227 "%s: %s.baseMipLevel (= %" PRIu32
3228 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 "). %s",
3229 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count,
3230 validation_error_map[errorCodes.base_mip_err]);
3231 }
Petr Kraus4d718682017-05-18 03:38:41 +02003232
Petr Krausffa94af2017-08-08 21:46:02 +02003233 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3234 if (subresourceRange.levelCount == 0) {
3235 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3236 __LINE__, errorCodes.mip_count_err, "IMAGE", "%s: %s.levelCount is 0. %s", cmd_name, param_name,
3237 validation_error_map[errorCodes.mip_count_err]);
3238 } else {
3239 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003240
Petr Krausffa94af2017-08-08 21:46:02 +02003241 if (necessary_mip_count > image_mip_count) {
3242 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3243 __LINE__, errorCodes.mip_count_err, "IMAGE",
3244 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3245 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 "). %s",
3246 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
3247 necessary_mip_count, image_mip_count, validation_error_map[errorCodes.mip_count_err]);
3248 }
Petr Kraus4d718682017-05-18 03:38:41 +02003249 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003250 }
Petr Kraus4d718682017-05-18 03:38:41 +02003251
3252 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003253 if (subresourceRange.baseArrayLayer >= image_layer_count) {
3254 skip |=
3255 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3256 errorCodes.base_layer_err, "IMAGE",
3257 "%s: %s.baseArrayLayer (= %" PRIu32
3258 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 "). %s",
3259 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count,
3260 validation_error_map[errorCodes.base_layer_err]);
3261 }
Petr Kraus4d718682017-05-18 03:38:41 +02003262
Petr Krausffa94af2017-08-08 21:46:02 +02003263 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3264 if (subresourceRange.layerCount == 0) {
3265 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3266 __LINE__, errorCodes.layer_count_err, "IMAGE", "%s: %s.layerCount is 0. %s", cmd_name, param_name,
3267 validation_error_map[errorCodes.layer_count_err]);
3268 } else {
3269 const uint64_t necessary_layer_count =
3270 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003271
Petr Krausffa94af2017-08-08 21:46:02 +02003272 if (necessary_layer_count > image_layer_count) {
3273 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3274 __LINE__, errorCodes.layer_count_err, "IMAGE",
3275 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3276 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 "). %s",
3277 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
3278 necessary_layer_count, image_layer_count_var_name, image_layer_count,
3279 validation_error_map[errorCodes.layer_count_err]);
3280 }
Petr Kraus4d718682017-05-18 03:38:41 +02003281 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003282 }
Petr Kraus4d718682017-05-18 03:38:41 +02003283
Mark Lobodzinski602de982017-02-09 11:01:33 -07003284 return skip;
3285}
3286
Petr Krausffa94af2017-08-08 21:46:02 +02003287bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3288 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3289 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3290 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3291 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3292 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3293
3294 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3295 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3296
3297 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3298 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
3299 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00b8e;
3300 subresourceRangeErrorCodes.base_layer_err =
3301 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3302 subresourceRangeErrorCodes.layer_count_err =
3303 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00b92;
3304
3305 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3306 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3307 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3308}
3309
3310bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3311 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3312 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3313 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
3314 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800b7e;
3315 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
3316 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800b82;
3317
3318 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3319 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3320 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3321}
3322
3323bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3324 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3325 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3326 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
3327 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00b86;
3328 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
3329 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00b8a;
3330
3331 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3332 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3333 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3334}
3335
3336bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3337 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3338 const char *param_name) {
3339 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3340 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
3341 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000b9e;
3342 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
3343 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000ba2;
3344
3345 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3346 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3347 subresourceRangeErrorCodes);
3348}
3349
Mark Lobodzinski602de982017-02-09 11:01:33 -07003350bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3351 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3352 bool skip = false;
3353 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3354 if (image_state) {
3355 skip |= ValidateImageUsageFlags(
3356 device_data, image_state,
3357 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houltona9df0ce2018-02-07 10:51:23 -07003358 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003359 false, -1, "vkCreateImageView()",
3360 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3361 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003362 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003363 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003364 skip |= ValidateCreateImageViewSubresourceRange(
3365 device_data, image_state,
3366 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3367 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003368
3369 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3370 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003371 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3372 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003373 VkFormat view_format = create_info->format;
3374 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003375 VkImageType image_type = image_state->createInfo.imageType;
3376 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003377
3378 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3379 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003380 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3381 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3382 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3383 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3384 std::stringstream ss;
3385 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3386 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3387 << ") format " << string_VkFormat(image_format)
3388 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3389 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3390 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3391 __LINE__, VALIDATION_ERROR_0ac007f4, "IMAGE", "%s %s", ss.str().c_str(),
3392 validation_error_map[VALIDATION_ERROR_0ac007f4]);
3393 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003394 }
3395 } else {
3396 // Format MUST be IDENTICAL to the format the image was created with
3397 if (image_format != view_format) {
3398 std::stringstream ss;
3399 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003400 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003401 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003402 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 -06003403 VALIDATION_ERROR_0ac007f6, "IMAGE", "%s %s", ss.str().c_str(),
3404 validation_error_map[VALIDATION_ERROR_0ac007f6]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003405 }
3406 }
3407
3408 // Validate correct image aspect bits for desired formats and format consistency
3409 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003410
3411 switch (image_type) {
3412 case VK_IMAGE_TYPE_1D:
3413 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
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",
3416 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3417 string_VkImageViewType(view_type), string_VkImageType(image_type),
3418 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3419 }
3420 break;
3421 case VK_IMAGE_TYPE_2D:
3422 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3423 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3424 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3425 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3426 __LINE__, VALIDATION_ERROR_0ac007d6, "IMAGE",
3427 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3428 string_VkImageViewType(view_type), string_VkImageType(image_type),
3429 validation_error_map[VALIDATION_ERROR_0ac007d6]);
3430 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3431 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3432 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3433 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3434 string_VkImageViewType(view_type), string_VkImageType(image_type),
3435 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3436 }
3437 }
3438 break;
3439 case VK_IMAGE_TYPE_3D:
3440 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3441 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3442 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3443 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
3444 skip |= log_msg(
3445 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3446 __LINE__, VALIDATION_ERROR_0ac007da, "IMAGE",
3447 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3448 string_VkImageViewType(view_type), string_VkImageType(image_type),
3449 validation_error_map[VALIDATION_ERROR_0ac007da]);
3450 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3451 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003452 skip |=
3453 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3454 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3455 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3456 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
3457 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled. %s",
3458 string_VkImageViewType(view_type), string_VkImageType(image_type),
3459 validation_error_map[VALIDATION_ERROR_0ac007fa]);
Jeremy Kniager846ab732017-07-10 13:12:04 -06003460 }
3461 } else {
3462 skip |=
3463 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3464 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3465 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3466 string_VkImageViewType(view_type), string_VkImageType(image_type),
3467 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3468 }
3469 }
3470 } else {
3471 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3473 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3474 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3475 string_VkImageViewType(view_type), string_VkImageType(image_type),
3476 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3477 }
3478 }
3479 break;
3480 default:
3481 break;
3482 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003483
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003484 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003485 bool check_tiling_features = false;
3486 VkFormatFeatureFlags tiling_features = 0;
3487 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3488 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3489 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3490 };
3491 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3492 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3493 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3494 };
3495 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3496 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003497 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003498 error_codes = linear_error_codes;
3499 check_tiling_features = true;
3500 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003501 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003502 error_codes = optimal_error_codes;
3503 check_tiling_features = true;
3504 }
3505
3506 if (check_tiling_features) {
3507 if (tiling_features == 0) {
3508 skip |=
3509 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3510 error_codes[0], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003511 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003512 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[0]]);
3513 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
3514 skip |=
3515 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3516 error_codes[1], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003517 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3518 "VK_IMAGE_USAGE_SAMPLED_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003519 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[1]]);
3520 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
3521 skip |=
3522 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3523 error_codes[2], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003524 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3525 "VK_IMAGE_USAGE_STORAGE_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003526 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[2]]);
3527 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3528 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
3529 skip |=
3530 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3531 error_codes[3], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003532 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3533 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003534 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[3]]);
3535 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3536 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
3537 skip |=
3538 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3539 error_codes[4], "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003540 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3541 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set. %s",
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003542 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[4]]);
3543 }
3544 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003545 }
3546 return skip;
3547}
3548
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003549void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3550 auto image_view_map = GetImageViewMap(device_data);
3551 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3552
3553 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003554 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003555 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3556 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003557}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003558
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003559bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3560 BUFFER_STATE *dst_buffer_state) {
3561 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003562 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3563 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003564 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003565 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3566 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3567 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3568 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003569 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003570 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003571 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003572 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003573 return skip;
3574}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003575
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003576void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3577 BUFFER_STATE *dst_buffer_state) {
3578 // Update bindings between buffers and cmd buffer
3579 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3580 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3581
3582 std::function<bool()> function = [=]() {
3583 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3584 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003585 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003586 function = [=]() {
3587 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3588 return false;
3589 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003590 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003591}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003592
3593static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3594 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3595 bool skip = false;
3596 auto buffer_state = GetBufferState(device_data, buffer);
3597 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003598 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 +01003599 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS", "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
3600 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003601 } else {
3602 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003603 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 -06003604 HandleToUint64(buffer), __LINE__, VALIDATION_ERROR_23c00734, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +01003605 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer. %s", HandleToUint64(buffer),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003606 validation_error_map[VALIDATION_ERROR_23c00734]);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003607 }
3608 }
3609 return skip;
3610}
3611
3612bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3613 VK_OBJECT *obj_struct) {
3614 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003615 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003616 if (GetDisables(device_data)->destroy_image_view) return false;
3617 bool skip = false;
3618 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003619 skip |=
3620 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003621 }
3622 return skip;
3623}
3624
3625void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3626 VK_OBJECT obj_struct) {
3627 // Any bound cmd buffers are now invalid
3628 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3629 (*GetImageViewMap(device_data)).erase(image_view);
3630}
3631
3632bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3633 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003634 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003635 if (GetDisables(device_data)->destroy_buffer) return false;
3636 bool skip = false;
3637 if (*buffer_state) {
3638 skip |= validateIdleBuffer(device_data, buffer);
3639 }
3640 return skip;
3641}
3642
3643void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3644 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3645 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3646 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3647 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003648 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003649 }
3650 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003651 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003652 GetBufferMap(device_data)->erase(buffer_state->buffer);
3653}
3654
3655bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3656 VK_OBJECT *obj_struct) {
3657 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003658 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003659 if (GetDisables(device_data)->destroy_buffer_view) return false;
3660 bool skip = false;
3661 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003662 skip |=
3663 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003664 }
3665 return skip;
3666}
3667
3668void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3669 VK_OBJECT obj_struct) {
3670 // Any bound cmd buffers are now invalid
3671 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3672 GetBufferViewMap(device_data)->erase(buffer_view);
3673}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003674
3675bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3676 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003677 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003678 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003679 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003680 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3681 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003682 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003683 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003684 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003685 return skip;
3686}
3687
3688void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3689 std::function<bool()> function = [=]() {
3690 SetBufferMemoryValid(device_data, buffer_state, true);
3691 return false;
3692 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003693 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003694 // Update bindings between buffer and cmd buffer
3695 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003696}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003697
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003698bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3699 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003700 bool skip = false;
3701
3702 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003703 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3704 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003705 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 -06003706 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160018e, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003707 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
3708 "and 1, respectively. %s",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003709 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003710 validation_error_map[VALIDATION_ERROR_0160018e]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003711 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003712 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003713
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003714 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3715 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003716 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 -06003717 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600192, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003718 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
3719 "must be 0 and 1, respectively. %s",
3720 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003721 validation_error_map[VALIDATION_ERROR_01600192]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003722 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003723 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003724
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003725 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3726 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
3727 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 -06003728 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001aa, "IMAGE",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003729 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
3730 "For 3D images these must be 0 and 1, respectively. %s",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003731 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003732 validation_error_map[VALIDATION_ERROR_016001aa]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003733 }
3734 }
3735
3736 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3737 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003738 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003739 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003740 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 -06003741 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600182, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003742 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
3743 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003744 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01600182]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003745 }
3746
3747 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003748 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003749 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 -06003750 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600184, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003751 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003752 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01600184]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003753 }
3754
3755 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3756 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
3757 skip |= log_msg(
3758 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003759 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600186, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003760 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
3761 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003762 validation_error_map[VALIDATION_ERROR_01600186]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003763 }
3764
3765 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3766 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3767 skip |= log_msg(
3768 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003769 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600188, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003770 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
3771 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003772 validation_error_map[VALIDATION_ERROR_01600188]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003773 }
3774
3775 // subresource aspectMask must have exactly 1 bit set
3776 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3777 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3778 if (aspect_mask_bits.count() != 1) {
3779 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 -06003780 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a8, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003781 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003782 validation_error_map[VALIDATION_ERROR_016001a8]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003783 }
3784
3785 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003786 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003787 skip |= log_msg(
3788 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003789 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a6, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003790 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
3791 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003792 validation_error_map[VALIDATION_ERROR_016001a6]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003793 }
3794
3795 // Checks that apply only to compressed images
3796 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3797 // reserves a place for these compressed image checks. This block of code could move there once the image
3798 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003799 if (FormatIsCompressed(image_state->createInfo.format)) {
3800 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003801
3802 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003803 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003804 skip |= log_msg(
3805 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003806 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600196, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003807 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003808 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01600196]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003809 }
3810
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003811 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003812 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003813 skip |= log_msg(
3814 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3815 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600198, "IMAGE",
3816 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d). %s.",
3817 function, i, pRegions[i].bufferImageHeight, block_size.height, validation_error_map[VALIDATION_ERROR_01600198]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003818 }
3819
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003820 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003821 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3822 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3823 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003824 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 -06003825 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019a, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003826 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3827 "width & height (%d, %d). %s.",
3828 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003829 block_size.height, validation_error_map[VALIDATION_ERROR_0160019a]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003830 }
3831
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003832 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003833 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3834 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003835 skip |= log_msg(
3836 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3837 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019c, "IMAGE",
3838 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3839 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
3840 function, i, pRegions[i].bufferOffset, block_size_in_bytes, validation_error_map[VALIDATION_ERROR_0160019c]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003841 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003842
3843 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003844 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003845 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003846 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3847 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 -06003848 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019e, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003849 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
3850 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
3851 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003852 mip_extent.width, validation_error_map[VALIDATION_ERROR_0160019e]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003853 }
3854
3855 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003856 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003857 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3858 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003859 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a0, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003860 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
3861 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
3862 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003863 mip_extent.height, validation_error_map[VALIDATION_ERROR_016001a0]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003864 }
3865
3866 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003867 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003868 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3869 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 -06003870 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a2, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003871 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
3872 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
3873 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003874 mip_extent.depth, validation_error_map[VALIDATION_ERROR_016001a2]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003875 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003876 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003877 }
3878
3879 return skip;
3880}
3881
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003882static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3883 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003884 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003885 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003886
3887 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003888 VkExtent3D extent = pRegions[i].imageExtent;
3889 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003890
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003891 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3892 {
3893 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3894 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
3895 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
3896 extent.height, extent.depth);
3897 }
3898
3899 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3900
3901 // 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 -06003902 if (FormatIsCompressed(image_info->format)) {
3903 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003904 if (image_extent.width % block_extent.width) {
3905 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3906 }
3907 if (image_extent.height % block_extent.height) {
3908 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3909 }
3910 if (image_extent.depth % block_extent.depth) {
3911 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3912 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003913 }
3914
Dave Houltonfc1a4052017-04-27 14:32:45 -06003915 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003916 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003917 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003918 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003919 }
3920 }
3921
3922 return skip;
3923}
3924
Chris Forbese8ba09a2017-06-01 17:39:02 -07003925static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003926 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3927 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003928 bool skip = false;
3929
3930 VkDeviceSize buffer_size = buff_state->createInfo.size;
3931
3932 for (uint32_t i = 0; i < regionCount; i++) {
3933 VkExtent3D copy_extent = pRegions[i].imageExtent;
3934
3935 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3936 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003937 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003938
Dave Houltonf3229d52017-02-21 15:59:08 -07003939 // Handle special buffer packing rules for specific depth/stencil formats
3940 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003941 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003942 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3943 switch (image_state->createInfo.format) {
3944 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003945 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003946 break;
3947 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003948 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003949 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003950 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003951 case VK_FORMAT_D24_UNORM_S8_UINT:
3952 unit_size = 4;
3953 break;
3954 default:
3955 break;
3956 }
3957 }
3958
Dave Houlton1d2022c2017-03-29 11:43:58 -06003959 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003960 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003961 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003962 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3963 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3964
3965 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3966 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3967 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003968 }
3969
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003970 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3971 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3972 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003973 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003974 } else {
3975 // Calculate buffer offset of final copied byte, + 1.
3976 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3977 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3978 max_buffer_offset *= unit_size; // convert to bytes
3979 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003980
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003981 if (buffer_size < max_buffer_offset) {
3982 skip |=
3983 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
3984 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
3985 i, buffer_size, validation_error_map[msg_code]);
3986 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003987 }
3988 }
3989
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003990 return skip;
3991}
3992
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003993bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003994 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003995 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003996 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3997 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
3998
3999 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004000 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004001
4002 // Command pool must support graphics, compute, or transfer operations
4003 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4004
4005 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4006 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4007 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 -06004008 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_19202415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004009 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
4010 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004011 validation_error_map[VALIDATION_ERROR_19202415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004012 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004013 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004014 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004015 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004016 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004017
4018 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004019 VALIDATION_ERROR_19200178);
4020 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
4021 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004022
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004023 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004024 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004025 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004026 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4027 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
4028 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004029 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004030 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004031 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
4032 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
4033 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004034 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06004035 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004036 }
4037 return skip;
4038}
4039
4040void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004041 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4042 VkImageLayout src_image_layout) {
4043 // Make sure that all image slices are updated to correct layout
4044 for (uint32_t i = 0; i < region_count; ++i) {
4045 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4046 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004047 // Update bindings between buffer/image and cmd buffer
4048 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004049 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004050
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004051 std::function<bool()> function = [=]() {
4052 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
4053 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004054 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004055 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004056 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004057 return false;
4058 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004059 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004060}
4061
4062bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004063 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004064 const VkBufferImageCopy *pRegions, const char *func_name) {
4065 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4066 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4067
4068 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004069 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004070
4071 // Command pool must support graphics, compute, or transfer operations
4072 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4073 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4074 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4075 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 -06004076 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_18e02415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004077 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
4078 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004079 validation_error_map[VALIDATION_ERROR_18e02415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004080 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004081 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004082 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004083 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004084 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004085 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004086 VALIDATION_ERROR_18e00166);
4087 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4088 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4089 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4090 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4091 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004092 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004093 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004094 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004095 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004096 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4097 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4098 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004099 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4100 "vkCmdCopyBufferToImage()");
4101 }
4102 return skip;
4103}
4104
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004105void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004106 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4107 VkImageLayout dst_image_layout) {
4108 // Make sure that all image slices are updated to correct layout
4109 for (uint32_t i = 0; i < region_count; ++i) {
4110 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4111 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004112 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004113 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004114 std::function<bool()> function = [=]() {
4115 SetImageMemoryValid(device_data, dst_image_state, true);
4116 return false;
4117 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004118 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004119 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004120 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004121}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004122
4123bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4124 const auto report_data = core_validation::GetReportData(device_data);
4125 bool skip = false;
4126 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4127
Dave Houlton1d960ff2018-01-19 12:17:05 -07004128 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004129 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4130 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4131 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004132 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 -06004133 __LINE__, VALIDATION_ERROR_2a6007ca, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004134 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004135 validation_error_map[VALIDATION_ERROR_2a6007ca]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004136 }
4137
4138 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4139 if (!image_entry) {
4140 return skip;
4141 }
4142
Dave Houlton1d960ff2018-01-19 12:17:05 -07004143 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004144 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004145 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 -06004146 __LINE__, VALIDATION_ERROR_2a6007c8, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004147 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004148 validation_error_map[VALIDATION_ERROR_2a6007c8]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004149 }
4150
Dave Houlton1d960ff2018-01-19 12:17:05 -07004151 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004152 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004153 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 -06004154 __LINE__, VALIDATION_ERROR_0a4007cc, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004155 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004156 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_0a4007cc]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004157 }
4158
Dave Houlton1d960ff2018-01-19 12:17:05 -07004159 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004160 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004161 skip |=
4162 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4163 __LINE__, VALIDATION_ERROR_0a4007ce, "IMAGE",
4164 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
4165 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_0a4007ce]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004166 }
4167
Dave Houlton1d960ff2018-01-19 12:17:05 -07004168 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004169 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004170 if (FormatIsMultiplane(img_format)) {
4171 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4172 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4173 if (FormatPlaneCount(img_format) > 2u) {
4174 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4175 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4176 }
4177 if (sub_aspect != (sub_aspect & allowed_flags)) {
4178 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4179 HandleToUint64(image), __LINE__, vuid, "IMAGE",
4180 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
4181 ") must be a single-plane specifier flag. %s",
4182 sub_aspect, validation_error_map[vuid]);
4183 }
4184 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004185 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004186 skip |= log_msg(
4187 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), __LINE__,
4188 VALIDATION_ERROR_0a400c01, "IMAGE",
4189 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
4190 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004191 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004192 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004193 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004194 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 -06004195 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004196 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
4197 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004198 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004199 }
4200 }
4201 return skip;
4202}